eventespresso / event-espresso-core

core/domain/entities/routing/specifications/RouteMatchSpecificationInterface.php

Indentation +7 added lines, -7 removed lines

@@ -14,11 +14,11 @@
  */
 interface RouteMatchSpecificationInterface extends InterminableInterface
 {
-    /**
-     * returns true if current request matches specification
-     *
-     * @since 4.9.71.p
-     * @return boolean
-     */
-    public function isMatchingRoute();
+	/**
+	 * returns true if current request matches specification
+	 *
+	 * @since 4.9.71.p
+	 * @return boolean
+	 */
+	public function isMatchingRoute();
 }

core/db_models/EEM_Payment.model.php

Indentation +313 added lines, -313 removed lines

@@ -12,347 +12,347 @@
  */
 class EEM_Payment extends EEM_Base implements EEMI_Payment
 {
-    /**
-     * Status id in esp_status table that represents an approved payment
-     */
-    const status_id_approved = 'PAP';
+	/**
+	 * Status id in esp_status table that represents an approved payment
+	 */
+	const status_id_approved = 'PAP';
 
-    /**
-     * Status id in esp_status table that represents a pending payment
-     */
-    const status_id_pending = 'PPN';
+	/**
+	 * Status id in esp_status table that represents a pending payment
+	 */
+	const status_id_pending = 'PPN';
 
-    /**
-     * Status id in esp_status table that represents a cancelled payment (eg, the
-     * user went to PayPal, but on the paypal site decided to cancel the payment)
-     */
-    const status_id_cancelled = 'PCN';
+	/**
+	 * Status id in esp_status table that represents a cancelled payment (eg, the
+	 * user went to PayPal, but on the paypal site decided to cancel the payment)
+	 */
+	const status_id_cancelled = 'PCN';
 
-    /**
-     * Status id in esp_status table that represents a payment that was declined by
-     * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
-     */
-    const status_id_declined = 'PDC';
+	/**
+	 * Status id in esp_status table that represents a payment that was declined by
+	 * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
+	 */
+	const status_id_declined = 'PDC';
 
-    /**
-     * Status id in esp_status table that represents a payment that failed for technical reasons.
-     * (Eg, there was some error in communicating with the payment gateway.)
-     */
-    const status_id_failed = 'PFL';
+	/**
+	 * Status id in esp_status table that represents a payment that failed for technical reasons.
+	 * (Eg, there was some error in communicating with the payment gateway.)
+	 */
+	const status_id_failed = 'PFL';
 
-    /**
-     * @var EE_Payment
-     */
-    protected static $_instance = null;
+	/**
+	 * @var EE_Payment
+	 */
+	protected static $_instance = null;
 
 
-    /**
-     * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item = esc_html__('Payment', 'event_espresso');
-        $this->plural_item   = esc_html__('Payments', 'event_espresso');
+	/**
+	 * @param string $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item = esc_html__('Payment', 'event_espresso');
+		$this->plural_item   = esc_html__('Payments', 'event_espresso');
 
-        $this->_tables = [
-            'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID'),
-        ];
-        $this->_fields = [
-            'Payment' => [
-                'PAY_ID'               => new EE_Primary_Key_Int_Field(
-                    'PAY_ID',
-                    esc_html__('Payment ID', 'event_espresso')
-                ),
-                'TXN_ID'               => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'STS_ID'               => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Payment::status_id_failed,
-                    'Status'
-                ),
-                'PAY_timestamp'        => new EE_Datetime_Field(
-                    'PAY_timestamp',
-                    esc_html__(
-                        'Timestamp of when payment was attempted',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'PAY_source'           => new EE_All_Caps_Text_Field(
-                    'PAY_source',
-                    esc_html__(
-                        'User-friendly description of payment',
-                        'event_espresso'
-                    ),
-                    false,
-                    'CART'
-                ),
-                'PAY_amount'           => new EE_Money_Field(
-                    'PAY_amount',
-                    esc_html__('Amount Payment should be for', 'event_espresso'),
-                    false
-                ),
-                'PMD_ID'               => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__("Payment Method ID", 'event_espresso'),
-                    false,
-                    null,
-                    'Payment_Method'
-                ),
-                'PAY_gateway_response' => new EE_Plain_Text_Field(
-                    'PAY_gateway_response',
-                    esc_html__(
-                        'Response from Gateway about the payment',
-                        'event_espresso'
-                    ),
-                    false,
-                    ''
-                ),
-                'PAY_txn_id_chq_nmbr'  => new EE_Plain_Text_Field(
-                    'PAY_txn_id_chq_nmbr',
-                    esc_html__(
-                        'Gateway Transaction ID or Cheque Number',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_po_number'        => new EE_Plain_Text_Field(
-                    'PAY_po_number',
-                    esc_html__(
-                        'Purchase or Sales Number',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_extra_accntng'    => new EE_Simple_HTML_Field(
-                    'PAY_extra_accntng',
-                    esc_html__('Extra Account Info', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PAY_details'          => new EE_Serialized_Text_Field(
-                    'PAY_details',
-                    esc_html__(
-                        'Full Gateway response about payment',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_redirect_url'     => new EE_Plain_Text_Field(
-                    'PAY_redirect_url',
-                    esc_html__("Redirect URL", 'event_espresso'),
-                    true
-                ),
-                'PAY_redirect_args'    => new EE_Serialized_Text_Field(
-                    'PAY_redirect_args',
-                    esc_html__(
-                        "Key-Value POST vars to send along with redirect",
-                        'event_espresso'
-                    ),
-                    true
-                ),
-            ],
-        ];
+		$this->_tables = [
+			'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID'),
+		];
+		$this->_fields = [
+			'Payment' => [
+				'PAY_ID'               => new EE_Primary_Key_Int_Field(
+					'PAY_ID',
+					esc_html__('Payment ID', 'event_espresso')
+				),
+				'TXN_ID'               => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'STS_ID'               => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Payment::status_id_failed,
+					'Status'
+				),
+				'PAY_timestamp'        => new EE_Datetime_Field(
+					'PAY_timestamp',
+					esc_html__(
+						'Timestamp of when payment was attempted',
+						'event_espresso'
+					),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'PAY_source'           => new EE_All_Caps_Text_Field(
+					'PAY_source',
+					esc_html__(
+						'User-friendly description of payment',
+						'event_espresso'
+					),
+					false,
+					'CART'
+				),
+				'PAY_amount'           => new EE_Money_Field(
+					'PAY_amount',
+					esc_html__('Amount Payment should be for', 'event_espresso'),
+					false
+				),
+				'PMD_ID'               => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					esc_html__("Payment Method ID", 'event_espresso'),
+					false,
+					null,
+					'Payment_Method'
+				),
+				'PAY_gateway_response' => new EE_Plain_Text_Field(
+					'PAY_gateway_response',
+					esc_html__(
+						'Response from Gateway about the payment',
+						'event_espresso'
+					),
+					false,
+					''
+				),
+				'PAY_txn_id_chq_nmbr'  => new EE_Plain_Text_Field(
+					'PAY_txn_id_chq_nmbr',
+					esc_html__(
+						'Gateway Transaction ID or Cheque Number',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_po_number'        => new EE_Plain_Text_Field(
+					'PAY_po_number',
+					esc_html__(
+						'Purchase or Sales Number',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_extra_accntng'    => new EE_Simple_HTML_Field(
+					'PAY_extra_accntng',
+					esc_html__('Extra Account Info', 'event_espresso'),
+					true,
+					''
+				),
+				'PAY_details'          => new EE_Serialized_Text_Field(
+					'PAY_details',
+					esc_html__(
+						'Full Gateway response about payment',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_redirect_url'     => new EE_Plain_Text_Field(
+					'PAY_redirect_url',
+					esc_html__("Redirect URL", 'event_espresso'),
+					true
+				),
+				'PAY_redirect_args'    => new EE_Serialized_Text_Field(
+					'PAY_redirect_args',
+					esc_html__(
+						"Key-Value POST vars to send along with redirect",
+						'event_espresso'
+					),
+					true
+				),
+			],
+		];
 
-        $this->_model_relations        = [
-            'Transaction'          => new EE_Belongs_To_Relation(),
-            'Status'               => new EE_Belongs_To_Relation(),
-            'Payment_Method'       => new EE_Belongs_To_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Registration'         => new EE_HABTM_Relation('Registration_Payment'),
-        ];
-        $this->_model_chain_to_wp_user = 'Payment_Method';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
+		$this->_model_relations        = [
+			'Transaction'          => new EE_Belongs_To_Relation(),
+			'Status'               => new EE_Belongs_To_Relation(),
+			'Payment_Method'       => new EE_Belongs_To_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Registration'         => new EE_HABTM_Relation('Registration_Payment'),
+		];
+		$this->_model_chain_to_wp_user = 'Payment_Method';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
-     * to the payment. This is handy for verifying an IPN hasn't already been processed.
-     *
-     * @param string $PAY_txn_id_chq_nmbr
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr): ?EE_Payment
-    {
-        return $this->get_one([['PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr]]);
-    }
+	/**
+	 * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
+	 * to the payment. This is handy for verifying an IPN hasn't already been processed.
+	 *
+	 * @param string $PAY_txn_id_chq_nmbr
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr): ?EE_Payment
+	{
+		return $this->get_one([['PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr]]);
+	}
 
 
-    /**
-     * retrieve  all payments from db for a particular transaction, optionally with a particular status
-     *
-     * @param int         $TXN_ID
-     * @param string|null $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided,
-     *                                       gets
-     *                                       payments with any status
-     * @return EE_Payment[]
-     * @throws EE_Error
-     */
-    public function get_payments_for_transaction(int $TXN_ID = 0, ?string $status_of_payment = null): array
-    {
-        // all payments for a TXN ordered chronologically
-        $query_params = [['TXN_ID' => $TXN_ID], 'order_by' => ['PAY_timestamp' => 'ASC']];
-        // if provided with a status, search specifically for that status. Otherwise get them all
-        if ($status_of_payment) {
-            $query_params[0]['STS_ID'] = $status_of_payment;
-        }
-        // retrieve payments
-        return $this->get_all($query_params);
-    }
+	/**
+	 * retrieve  all payments from db for a particular transaction, optionally with a particular status
+	 *
+	 * @param int         $TXN_ID
+	 * @param string|null $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided,
+	 *                                       gets
+	 *                                       payments with any status
+	 * @return EE_Payment[]
+	 * @throws EE_Error
+	 */
+	public function get_payments_for_transaction(int $TXN_ID = 0, ?string $status_of_payment = null): array
+	{
+		// all payments for a TXN ordered chronologically
+		$query_params = [['TXN_ID' => $TXN_ID], 'order_by' => ['PAY_timestamp' => 'ASC']];
+		// if provided with a status, search specifically for that status. Otherwise get them all
+		if ($status_of_payment) {
+			$query_params[0]['STS_ID'] = $status_of_payment;
+		}
+		// retrieve payments
+		return $this->get_all($query_params);
+	}
 
 
-    /**
-     * Only gets payments which have been approved
-     *
-     * @param int $TXN_ID
-     * @return EE_Payment[]
-     * @throws EE_Error
-     */
-    public function get_approved_payments_for_transaction(int $TXN_ID = 0): array
-    {
-        return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
-    }
+	/**
+	 * Only gets payments which have been approved
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Payment[]
+	 * @throws EE_Error
+	 */
+	public function get_approved_payments_for_transaction(int $TXN_ID = 0): array
+	{
+		return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
+	}
 
 
-    /**
-     * retrieve  all payments from db between two dates,
-     *
-     * @param string $start_date        incoming start date. If empty the beginning of today is used.
-     * @param string $end_date          incoming end date. If empty the end of today is used.
-     * @param string $format            If you include $start_date or $end_date then you must include the format string
-     *                                  for the format your date is in.
-     * @param string $timezone          If your range is in a different timezone then the current setting on this
-     *                                  WordPress install, then include it here.
-     * @return EE_Payment[]
-     * @throws EE_Error
-     *
-     */
-    public function get_payments_made_between_dates(
-        string $start_date = '',
-        string $end_date = '',
-        string $format = '',
-        string $timezone = ''
-    ): array {
-        $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
-        // if $start_date or $end date, verify $format is included.
-        if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
-            throw new EE_Error(
-                esc_html__(
-                    'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
-                    'event_espresso'
-                )
-            );
-        }
-        $now = new DateTime('now');
-        // setup timezone objects once
-        $modelDateTimeZone  = new DateTimeZone($this->_timezone);
-        $passedDateTimeZone = new DateTimeZone($timezone);
-        // setup start date
-        $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
-        $start_date = strtotime($start_date);
-        // setup end date
-        $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
-        $end_date = strtotime($end_date);
+	/**
+	 * retrieve  all payments from db between two dates,
+	 *
+	 * @param string $start_date        incoming start date. If empty the beginning of today is used.
+	 * @param string $end_date          incoming end date. If empty the end of today is used.
+	 * @param string $format            If you include $start_date or $end_date then you must include the format string
+	 *                                  for the format your date is in.
+	 * @param string $timezone          If your range is in a different timezone then the current setting on this
+	 *                                  WordPress install, then include it here.
+	 * @return EE_Payment[]
+	 * @throws EE_Error
+	 *
+	 */
+	public function get_payments_made_between_dates(
+		string $start_date = '',
+		string $end_date = '',
+		string $format = '',
+		string $timezone = ''
+	): array {
+		$timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
+		// if $start_date or $end date, verify $format is included.
+		if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
+			throw new EE_Error(
+				esc_html__(
+					'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
+					'event_espresso'
+				)
+			);
+		}
+		$now = new DateTime('now');
+		// setup timezone objects once
+		$modelDateTimeZone  = new DateTimeZone($this->_timezone);
+		$passedDateTimeZone = new DateTimeZone($timezone);
+		// setup start date
+		$start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
+		$start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+		$start_date = strtotime($start_date);
+		// setup end date
+		$end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
+		$end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+		$end_date = strtotime($end_date);
 
-        // make sure our start date is the lowest value and vice versa
-        $start = min($start_date, $end_date);
-        $end   = max($start_date, $end_date);
+		// make sure our start date is the lowest value and vice versa
+		$start = min($start_date, $end_date);
+		$end   = max($start_date, $end_date);
 
-        // yes we generated the date and time string in utc
-        // but we WANT this start date and time used in the set timezone on the model.
-        $start_date = $this->convert_datetime_for_query(
-            'PAY_timestamp',
-            date('Y-m-d', $start) . ' 00:00:00',
-            'Y-m-d H:i:s',
-            $this->get_timezone()
-        );
-        $end_date   = $this->convert_datetime_for_query(
-            'PAY_timestamp',
-            date('Y-m-d', $end) . ' 23:59:59',
-            'Y-m-d H:i:s',
-            $this->get_timezone()
-        );
+		// yes we generated the date and time string in utc
+		// but we WANT this start date and time used in the set timezone on the model.
+		$start_date = $this->convert_datetime_for_query(
+			'PAY_timestamp',
+			date('Y-m-d', $start) . ' 00:00:00',
+			'Y-m-d H:i:s',
+			$this->get_timezone()
+		);
+		$end_date   = $this->convert_datetime_for_query(
+			'PAY_timestamp',
+			date('Y-m-d', $end) . ' 23:59:59',
+			'Y-m-d H:i:s',
+			$this->get_timezone()
+		);
 
-        return $this->get_all([['PAY_timestamp' => ['>=', $start_date], 'PAY_timestamp*' => ['<=', $end_date]]]);
-    }
+		return $this->get_all([['PAY_timestamp' => ['>=', $start_date], 'PAY_timestamp*' => ['<=', $end_date]]]);
+	}
 
 
-    /**
-     * returns a string for the approved status
-     *
-     * @return string
-     */
-    public function approved_status(): string
-    {
-        return self::status_id_approved;
-    }
+	/**
+	 * returns a string for the approved status
+	 *
+	 * @return string
+	 */
+	public function approved_status(): string
+	{
+		return self::status_id_approved;
+	}
 
 
-    /**
-     * returns a string for the pending status
-     *
-     * @return string
-     */
-    public function pending_status(): string
-    {
-        return self::status_id_pending;
-    }
+	/**
+	 * returns a string for the pending status
+	 *
+	 * @return string
+	 */
+	public function pending_status(): string
+	{
+		return self::status_id_pending;
+	}
 
 
-    /**
-     * returns a string for the cancelled status
-     *
-     * @return string
-     */
-    public function cancelled_status(): string
-    {
-        return self::status_id_cancelled;
-    }
+	/**
+	 * returns a string for the cancelled status
+	 *
+	 * @return string
+	 */
+	public function cancelled_status(): string
+	{
+		return self::status_id_cancelled;
+	}
 
 
-    /**
-     * returns a string for the failed status
-     *
-     * @return string
-     */
-    public function failed_status(): string
-    {
-        return self::status_id_failed;
-    }
+	/**
+	 * returns a string for the failed status
+	 *
+	 * @return string
+	 */
+	public function failed_status(): string
+	{
+		return self::status_id_failed;
+	}
 
 
-    /**
-     * returns a string for the declined status
-     *
-     * @return string
-     */
-    public function declined_status(): string
-    {
-        return self::status_id_declined;
-    }
+	/**
+	 * returns a string for the declined status
+	 *
+	 * @return string
+	 */
+	public function declined_status(): string
+	{
+		return self::status_id_declined;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -172,7 +172,7 @@ 
             ],
         ];
 
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Transaction'          => new EE_Belongs_To_Relation(),
             'Status'               => new EE_Belongs_To_Relation(),
             'Payment_Method'       => new EE_Belongs_To_Relation(),
@@ -256,7 +256,7 @@ 
     ): array {
         $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
         // if $start_date or $end date, verify $format is included.
-        if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
+        if (( ! empty($start_date) || ! empty($end_date)) && empty($format)) {
             throw new EE_Error(
                 esc_html__(
                     'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
@@ -271,12 +271,12 @@ 
         // setup start date
         $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+        $start_date = $start_date->format('Y-m-d').' 00:00:00';
         $start_date = strtotime($start_date);
         // setup end date
         $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+        $end_date = $end_date->format('Y-m-d').' 23:59:59';
         $end_date = strtotime($end_date);
 
         // make sure our start date is the lowest value and vice versa
@@ -287,13 +287,13 @@ 
         // but we WANT this start date and time used in the set timezone on the model.
         $start_date = $this->convert_datetime_for_query(
             'PAY_timestamp',
-            date('Y-m-d', $start) . ' 00:00:00',
+            date('Y-m-d', $start).' 00:00:00',
             'Y-m-d H:i:s',
             $this->get_timezone()
         );
-        $end_date   = $this->convert_datetime_for_query(
+        $end_date = $this->convert_datetime_for_query(
             'PAY_timestamp',
-            date('Y-m-d', $end) . ' 23:59:59',
+            date('Y-m-d', $end).' 23:59:59',
             'Y-m-d H:i:s',
             $this->get_timezone()
         );

core/EE_Registry.core.php

Indentation +1746 added lines, -1746 removed lines

@@ -22,1750 +22,1750 @@
  */
 class EE_Registry implements ResettableInterface
 {
-    /**
-     * @var EE_Registry $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Dependency_Map $_dependency_map
-     */
-    protected $_dependency_map;
-
-    /**
-     * @var Mirror
-     */
-    private $mirror;
-
-    /**
-     * @var ClassInterfaceCache $class_cache
-     */
-    private $class_cache;
-
-    /**
-     * @var array $_class_abbreviations
-     */
-    protected $_class_abbreviations = [];
-
-    /**
-     * @var CommandBusInterface $BUS
-     */
-    public $BUS;
-
-    /**
-     * @var EE_Cart $CART
-     */
-    public $CART;
-
-    /**
-     * @var EE_Config $CFG
-     */
-    public $CFG;
-
-    /**
-     * @var EE_Network_Config $NET_CFG
-     */
-    public $NET_CFG;
-
-    /**
-     * RegistryContainer for storing library classes in
-     *
-     * @var RegistryContainer $LIB
-     */
-    public $LIB;
-
-    /**
-     * @var EE_Request_Handler $REQ
-     * @deprecated 4.10.14.p
-     */
-    public $REQ;
-
-    /**
-     * @var EE_Session $SSN
-     */
-    public $SSN;
-
-    /**
-     * @since 4.5.0
-     * @var EE_Capabilities $CAP
-     */
-    public $CAP;
-
-    /**
-     * @since 4.9.0
-     * @var EE_Message_Resource_Manager $MRM
-     */
-    public $MRM;
-
-    /**
-     * @var Registry $AssetsRegistry
-     */
-    public $AssetsRegistry;
-
-    /**
-     * 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 $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 $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 $i18n_js_strings = [];
-
-    /**
-     * $main_file - path to espresso.php
-     *
-     * @var array $main_file
-     */
-    public $main_file;
-
-    /**
-     * array of ReflectionClass objects where the key is the class name
-     *
-     * @deprecated 4.9.62.p
-     * @var ReflectionClass[] $_reflectors
-     */
-    public $_reflectors;
-
-    /**
-     * boolean flag to indicate whether or not to load/save dependencies from/to the cache
-     *
-     * @var boolean $_cache_on
-     */
-    protected $_cache_on = true;
-
-    /**
-     * @var ObjectIdentifier
-     */
-    private $object_identifier;
-
-
-    /**
-     * @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;
-        // $registry_container = new RegistryContainer();
-        $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
-    {
-        $i18n_js_strings = (array) self::$i18n_js_strings;
-        foreach ($i18n_js_strings as $key => $value) {
-            if (is_scalar($value)) {
-                $decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-                $i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
-            }
-        }
-        return $i18n_js_strings;
-    }
-
-
-    /**
-     * localize_i18n_js_strings
-     *
-     * @return string
-     */
-    public static function localize_i18n_js_strings(): string
-    {
-        $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($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 bool|null|object
-     * @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} instanceof InterminableInterface) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name}) && ! $this->{$class_name} instanceof InterminableInterface) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && $this->addons->has($class_name)) {
-            $this->addons->remove($class_name);
-            return true;
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if (
-            $this->LIB->has($object_identifier)
-            && ! $this->LIB->get($object_identifier) instanceof InterminableInterface
-        ) {
-            $this->LIB->remove($object_identifier);
-            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 of 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->getFqnForAlias($param_class, $class_name);
-            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 mixed
-     */
-    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 InterminableInterface) {
-            // don't unset anything that's not terminable
-            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;
-        }
-        // at least clear object from cache
-        self::$_instance->clear_cached_class(get_class($object));
-        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',
-            ]
-        );
-    }
+	/**
+	 * @var EE_Registry $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Dependency_Map $_dependency_map
+	 */
+	protected $_dependency_map;
+
+	/**
+	 * @var Mirror
+	 */
+	private $mirror;
+
+	/**
+	 * @var ClassInterfaceCache $class_cache
+	 */
+	private $class_cache;
+
+	/**
+	 * @var array $_class_abbreviations
+	 */
+	protected $_class_abbreviations = [];
+
+	/**
+	 * @var CommandBusInterface $BUS
+	 */
+	public $BUS;
+
+	/**
+	 * @var EE_Cart $CART
+	 */
+	public $CART;
+
+	/**
+	 * @var EE_Config $CFG
+	 */
+	public $CFG;
+
+	/**
+	 * @var EE_Network_Config $NET_CFG
+	 */
+	public $NET_CFG;
+
+	/**
+	 * RegistryContainer for storing library classes in
+	 *
+	 * @var RegistryContainer $LIB
+	 */
+	public $LIB;
+
+	/**
+	 * @var EE_Request_Handler $REQ
+	 * @deprecated 4.10.14.p
+	 */
+	public $REQ;
+
+	/**
+	 * @var EE_Session $SSN
+	 */
+	public $SSN;
+
+	/**
+	 * @since 4.5.0
+	 * @var EE_Capabilities $CAP
+	 */
+	public $CAP;
+
+	/**
+	 * @since 4.9.0
+	 * @var EE_Message_Resource_Manager $MRM
+	 */
+	public $MRM;
+
+	/**
+	 * @var Registry $AssetsRegistry
+	 */
+	public $AssetsRegistry;
+
+	/**
+	 * 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 $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 $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 $i18n_js_strings = [];
+
+	/**
+	 * $main_file - path to espresso.php
+	 *
+	 * @var array $main_file
+	 */
+	public $main_file;
+
+	/**
+	 * array of ReflectionClass objects where the key is the class name
+	 *
+	 * @deprecated 4.9.62.p
+	 * @var ReflectionClass[] $_reflectors
+	 */
+	public $_reflectors;
+
+	/**
+	 * boolean flag to indicate whether or not to load/save dependencies from/to the cache
+	 *
+	 * @var boolean $_cache_on
+	 */
+	protected $_cache_on = true;
+
+	/**
+	 * @var ObjectIdentifier
+	 */
+	private $object_identifier;
+
+
+	/**
+	 * @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;
+		// $registry_container = new RegistryContainer();
+		$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
+	{
+		$i18n_js_strings = (array) self::$i18n_js_strings;
+		foreach ($i18n_js_strings as $key => $value) {
+			if (is_scalar($value)) {
+				$decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
+				$i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
+			}
+		}
+		return $i18n_js_strings;
+	}
+
+
+	/**
+	 * localize_i18n_js_strings
+	 *
+	 * @return string
+	 */
+	public static function localize_i18n_js_strings(): string
+	{
+		$i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
+		return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($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 bool|null|object
+	 * @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} instanceof InterminableInterface) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name}) && ! $this->{$class_name} instanceof InterminableInterface) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && $this->addons->has($class_name)) {
+			$this->addons->remove($class_name);
+			return true;
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if (
+			$this->LIB->has($object_identifier)
+			&& ! $this->LIB->get($object_identifier) instanceof InterminableInterface
+		) {
+			$this->LIB->remove($object_identifier);
+			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 of 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->getFqnForAlias($param_class, $class_name);
+			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 mixed
+	 */
+	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 InterminableInterface) {
+			// don't unset anything that's not terminable
+			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;
+		}
+		// at least clear object from cache
+		self::$_instance->clear_cached_class(get_class($object));
+		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

@@ -308,7 +308,7 @@ 
         foreach ($i18n_js_strings as $key => $value) {
             if (is_scalar($value)) {
                 $decoded_value           = html_entity_decode((string) $value, ENT_QUOTES, 'UTF-8');
-                $i18n_js_strings[ $key ] = wp_strip_all_tags($decoded_value);
+                $i18n_js_strings[$key] = wp_strip_all_tags($decoded_value);
             }
         }
         return $i18n_js_strings;
@@ -323,7 +323,7 @@ 
     public static function localize_i18n_js_strings(): string
     {
         $i18n_js_strings = EE_Registry::sanitize_i18n_js_strings();
-        return '/* <![CDATA[ */ var eei18n = ' . wp_json_encode($i18n_js_strings) . '; /* ]]> */';
+        return '/* <![CDATA[ */ var eei18n = '.wp_json_encode($i18n_js_strings).'; /* ]]> */';
     }
 
 
@@ -342,7 +342,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);
@@ -381,10 +381,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
@@ -420,7 +420,7 @@ 
         $service_paths = (array) apply_filters(
             'FHEE__EE_Registry__load_service__service_paths',
             [
-                EE_CORE . 'services/',
+                EE_CORE.'services/',
             ]
         );
         // retrieve instantiated class
@@ -560,10 +560,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(
@@ -632,10 +632,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(
@@ -659,7 +659,7 @@ 
      */
     public function is_model_name(string $model_name): bool
     {
-        return isset($this->models[ $model_name ]);
+        return isset($this->models[$model_name]);
     }
 
 
@@ -791,7 +791,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 {
@@ -833,7 +833,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:
@@ -887,11 +887,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);
@@ -911,7 +911,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
@@ -922,7 +922,7 @@ 
                 return $loaded;
             }
             // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
+            if ( ! $loaded) {
                 return null;
             }
         }
@@ -950,7 +950,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;
     }
 
 
@@ -1086,7 +1086,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);
         }
@@ -1117,13 +1117,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;
@@ -1148,7 +1148,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,
@@ -1166,7 +1166,7 @@ 
                         ),
                         trim($type, '.'),
                         $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
+                        '<br />'.implode(',<br />', $file_paths)
                     )
                 );
             }
@@ -1209,8 +1209,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) {
         }
@@ -1363,7 +1363,7 @@ 
         // let's examine the constructor
         $constructor = $this->mirror->getConstructorFromReflection($reflector);
         // whu? huh? nothing?
-        if (! $constructor) {
+        if ( ! $constructor) {
             return $arguments;
         }
         // get constructor parameters
@@ -1391,7 +1391,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;
@@ -1401,8 +1401,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;
@@ -1417,17 +1417,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;
             }
         }
@@ -1486,7 +1486,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;
     }
@@ -1577,7 +1577,7 @@ 
     {
         $addons = [];
         foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
+            $addons[$addon->name()] = $addon;
         }
         return $addons;
     }
@@ -1597,11 +1597,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
@@ -1687,7 +1687,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;
         }
@@ -1727,7 +1727,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;