eventespresso / event-espresso-core

core/libraries/rest_api/controllers/model/Meta.php

Indentation +114 added lines, -114 removed lines

@@ -25,124 +25,124 @@
  */
 class Meta extends Base
 {
-    /**
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @return WP_REST_Response
-     */
-    public static function handleRequestModelsMeta(WP_REST_Request $request, string $version): WP_REST_Response
-    {
-        $controller = new Meta();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse($controller->getModelsMetadataEntity());
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @return WP_REST_Response
+	 */
+	public static function handleRequestModelsMeta(WP_REST_Request $request, string $version): WP_REST_Response
+	{
+		$controller = new Meta();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse($controller->getModelsMetadataEntity());
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Gets the model metadata resource entity
-     *
-     * @return array for JSON response, describing all the models available in teh requested version
-     * @throws EE_Error
-     */
-    protected function getModelsMetadataEntity(): array
-    {
-        $response = [];
-        foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
-            $model       = $this->getModelVersionInfo()->loadModel($model_name);
-            $fields_json = [];
-            foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
-                if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
-                    continue;
-                }
-                if ($field_obj instanceof EE_Boolean_Field) {
-                    $datatype = 'Boolean';
-                } elseif ($field_obj->get_wpdb_data_type() == '%d') {
-                    $datatype = 'Number';
-                } elseif ($field_name instanceof EE_Serialized_Text_Field) {
-                    $datatype = 'Object';
-                } else {
-                    $datatype = 'String';
-                }
-                $default_value                      = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-                $field_json                         = [
-                    'name'                => $field_name,
-                    'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
-                    'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
-                    'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
-                    'type'                => str_replace('EE_', '', get_class($field_obj)),
-                    'datatype'            => $datatype,
-                    'nullable'            => $field_obj->is_nullable(),
-                    'default'             => $default_value,
-                    'table_alias'         => $field_obj->get_table_alias(),
-                    'table_column'        => $field_obj->get_table_column(),
-                ];
-                $fields_json[ $field_json['name'] ] = $field_json;
-            }
-            $fields_json                       = array_merge(
-                $fields_json,
-                $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
-            );
-            $response[ $model_name ]['fields'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__fields',
-                $fields_json,
-                $model
-            );
-            $relations_json                    = [];
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $relation_json                    = [
-                    'name'   => $relation_name,
-                    'type'   => str_replace('EE_', '', get_class($relation_obj)),
-                    'single' => $relation_obj instanceof EE_Belongs_To_Relation,
-                ];
-                $relations_json[ $relation_name ] = $relation_json;
-            }
-            $response[ $model_name ]['relations'] = apply_filters(
-                'FHEE__Meta__handle_request_models_meta__relations',
-                $relations_json,
-                $model
-            );
-        }
-        return $response;
-    }
+	/**
+	 * Gets the model metadata resource entity
+	 *
+	 * @return array for JSON response, describing all the models available in teh requested version
+	 * @throws EE_Error
+	 */
+	protected function getModelsMetadataEntity(): array
+	{
+		$response = [];
+		foreach ($this->getModelVersionInfo()->modelsForRequestedVersion() as $model_name => $model_classname) {
+			$model       = $this->getModelVersionInfo()->loadModel($model_name);
+			$fields_json = [];
+			foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field_obj) {
+				if ($this->getModelVersionInfo()->fieldIsIgnored($field_obj)) {
+					continue;
+				}
+				if ($field_obj instanceof EE_Boolean_Field) {
+					$datatype = 'Boolean';
+				} elseif ($field_obj->get_wpdb_data_type() == '%d') {
+					$datatype = 'Number';
+				} elseif ($field_name instanceof EE_Serialized_Text_Field) {
+					$datatype = 'Object';
+				} else {
+					$datatype = 'String';
+				}
+				$default_value                      = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+				$field_json                         = [
+					'name'                => $field_name,
+					'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
+					'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
+					'has_pretty_format'   => $this->getModelVersionInfo()->fieldHasPrettyFormat($field_obj),
+					'type'                => str_replace('EE_', '', get_class($field_obj)),
+					'datatype'            => $datatype,
+					'nullable'            => $field_obj->is_nullable(),
+					'default'             => $default_value,
+					'table_alias'         => $field_obj->get_table_alias(),
+					'table_column'        => $field_obj->get_table_column(),
+				];
+				$fields_json[ $field_json['name'] ] = $field_json;
+			}
+			$fields_json                       = array_merge(
+				$fields_json,
+				$this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
+			);
+			$response[ $model_name ]['fields'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__fields',
+				$fields_json,
+				$model
+			);
+			$relations_json                    = [];
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$relation_json                    = [
+					'name'   => $relation_name,
+					'type'   => str_replace('EE_', '', get_class($relation_obj)),
+					'single' => $relation_obj instanceof EE_Belongs_To_Relation,
+				];
+				$relations_json[ $relation_name ] = $relation_json;
+			}
+			$response[ $model_name ]['relations'] = apply_filters(
+				'FHEE__Meta__handle_request_models_meta__relations',
+				$relations_json,
+				$model
+			);
+		}
+		return $response;
+	}
 
 
-    /**
-     * Adds EE metadata to the index
-     *
-     * @param WP_REST_Response $rest_response_obj
-     * @return WP_REST_Response
-     */
-    public static function filterEeMetadataIntoIndex(WP_REST_Response $rest_response_obj): WP_REST_Response
-    {
-        $response_data = $rest_response_obj->get_data();
-        $addons        = [];
-        foreach (EE_Registry::instance()->addons as $addon) {
-            $addon_json                    = [
-                'name'    => $addon->name(),
-                'version' => $addon->version(),
-            ];
-            $addons[ $addon_json['name'] ] = $addon_json;
-        }
-        $response_data['ee'] = [
-            'version'              => EEM_System_Status::instance()->get_ee_version(),
-            // @codingStandardsIgnoreStart
-            'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
-            // @codingStandardsIgnoreEnd
-            'addons'               => $addons,
-            'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
-            'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
-        ];
-        $rest_response_obj->set_data($response_data);
-        return $rest_response_obj;
-    }
+	/**
+	 * Adds EE metadata to the index
+	 *
+	 * @param WP_REST_Response $rest_response_obj
+	 * @return WP_REST_Response
+	 */
+	public static function filterEeMetadataIntoIndex(WP_REST_Response $rest_response_obj): WP_REST_Response
+	{
+		$response_data = $rest_response_obj->get_data();
+		$addons        = [];
+		foreach (EE_Registry::instance()->addons as $addon) {
+			$addon_json                    = [
+				'name'    => $addon->name(),
+				'version' => $addon->version(),
+			];
+			$addons[ $addon_json['name'] ] = $addon_json;
+		}
+		$response_data['ee'] = [
+			'version'              => EEM_System_Status::instance()->get_ee_version(),
+			// @codingStandardsIgnoreStart
+			'documentation_url'    => 'https://github.com/eventespresso/event-espresso-core/tree/master/docs/C--REST-API',
+			// @codingStandardsIgnoreEnd
+			'addons'               => $addons,
+			'maintenance_mode'     => EE_Maintenance_Mode::instance()->real_level(),
+			'served_core_versions' => array_keys(EED_Core_Rest_Api::versions_served()),
+		];
+		$rest_response_obj->set_data($response_data);
+		return $rest_response_obj;
+	}
 }
 
 

Spacing +11 added lines, -11 removed lines

@@ -67,12 +67,12 @@ 
                 } else {
                     $datatype = 'String';
                 }
-                $default_value                      = ModelDataTranslator::prepareFieldValueForJson(
+                $default_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
                     $field_obj->get_default_value(),
                     $this->getModelVersionInfo()->requestedVersion()
                 );
-                $field_json                         = [
+                $field_json = [
                     'name'                => $field_name,
                     'nicename'            => wp_specialchars_decode($field_obj->get_nicename(), ENT_QUOTES),
                     'has_rendered_format' => $this->getModelVersionInfo()->fieldHasRenderedFormat($field_obj),
@@ -84,27 +84,27 @@ 
                     'table_alias'         => $field_obj->get_table_alias(),
                     'table_column'        => $field_obj->get_table_column(),
                 ];
-                $fields_json[ $field_json['name'] ] = $field_json;
+                $fields_json[$field_json['name']] = $field_json;
             }
-            $fields_json                       = array_merge(
+            $fields_json = array_merge(
                 $fields_json,
                 $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
             );
-            $response[ $model_name ]['fields'] = apply_filters(
+            $response[$model_name]['fields'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__fields',
                 $fields_json,
                 $model
             );
-            $relations_json                    = [];
+            $relations_json = [];
             foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $relation_json                    = [
+                $relation_json = [
                     'name'   => $relation_name,
                     'type'   => str_replace('EE_', '', get_class($relation_obj)),
                     'single' => $relation_obj instanceof EE_Belongs_To_Relation,
                 ];
-                $relations_json[ $relation_name ] = $relation_json;
+                $relations_json[$relation_name] = $relation_json;
             }
-            $response[ $model_name ]['relations'] = apply_filters(
+            $response[$model_name]['relations'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__relations',
                 $relations_json,
                 $model
@@ -125,11 +125,11 @@ 
         $response_data = $rest_response_obj->get_data();
         $addons        = [];
         foreach (EE_Registry::instance()->addons as $addon) {
-            $addon_json                    = [
+            $addon_json = [
                 'name'    => $addon->name(),
                 'version' => $addon->version(),
             ];
-            $addons[ $addon_json['name'] ] = $addon_json;
+            $addons[$addon_json['name']] = $addon_json;
         }
         $response_data['ee'] = [
             'version'              => EEM_System_Status::instance()->get_ee_version(),

core/libraries/rest_api/controllers/model/Read.php

Indentation +1644 added lines, -1644 removed lines

@@ -50,1648 +50,1648 @@
  */
 class Read extends Base
 {
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     *
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(CalculatedModelFields $fields_calculator)
-    {
-        parent::__construct();
-        $this->fields_calculator = $fields_calculator;
-    }
-
-
-    /**
-     * @param string $version
-     * @return Read
-     * @since $VID:$
-     */
-    public static function getModelReadController(string $version): Read
-    {
-        /** @var Read $controller */
-        $controller = LoaderFactory::getLoader()->getNew(Read::class);
-        $controller->setRequestedVersion($version);
-        return $controller;
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleRequestGetAll(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name
-    ): WP_REST_Response {
-        $controller = Read::getModelReadController($version);
-        try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(Read::endpointParsingError($model_name));
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version    The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleSchemaRequest(string $version, string $model_name): array
-    {
-        $controller = Read::getModelReadController($version);
-        try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return [];
-            }
-            // get the model for this version
-            $model        = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema(
-                $model,
-                LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields')
-            );
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return [];
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema): array
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws RestException  if a default value has a PHP object, which we should never do
-     *                                  (but if we did, let's know about it ASAP, so let the exception bubble up)
-     * @throws EE_Error
-     *
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest(): string
-    {
-        if (
-            isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            /** @var RequestInterface $request */
-            $request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            return $request->serverParamIsSet('PATH_INFO')
-                ? $request->getServerParam('PATH_INFO')
-                : '/';
-        }
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetOne(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name
-    ): WP_REST_Response {
-        $controller = Read::getModelReadController($version);
-        try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(Read::endpointParsingError($model_name));
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @param string          $related_model_name
-     * @return WP_REST_Response
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        string $version,
-        string $model_name,
-        string $related_model_name
-    ): WP_REST_Response {
-        $controller = Read::getModelReadController($version);
-        try {
-            $main_model = $controller->validateModel($model_name);
-            $controller->validateModel($related_model_name);
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     */
-    public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                ['status' => 403]
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results      = $model->get_all_wpdb_results($query_params);
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                  $primary_model_query_params  query params for finding the item from which
-     *                                                            relations will be based
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request        $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws ModelConfigurationException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams(
-        array $primary_model_query_params,
-        EE_Model_Relation_Base $relation,
-        WP_REST_Request $request
-    ): array {
-        $context       = $this->validateContext($request->get_param('caps'));
-        $model         = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = [];
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = [
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        ];
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params          = $primary_model_query_params;
-        $restricted_query_params['caps']  = $context;
-        $restricted_query_params['limit'] = 1;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        $primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        $primary_model_row  = null;
-        if (is_array($primary_model_rows)) {
-            $primary_model_row = reset($primary_model_rows);
-        }
-        if (
-            ! (
-                $primary_model_row
-                && Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    esc_html__(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                ['status' => 403]
-            );
-        }
-
-        $this->checkPassword(
-            $model,
-            $primary_model_row,
-            $restricted_query_params,
-            $request
-        );
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps']                     = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results      = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = [];
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result     = array_merge($join_model_result, $nice_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                 $id the ID of the thing we are fetching related stuff from
-     * @param EE_Model_Relation_Base $relation
-     * @param WP_REST_Request        $request
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getEntitiesFromRelation(
-        string $id,
-        EE_Model_Relation_Base $relation,
-        WP_REST_Request $request
-    ): array {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        // can we edit that main item?
-        // if not, show nothing but an error
-        // otherwise, please proceed
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            [
-                [
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ],
-            ],
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function setHeadersFromQueryParams(EEM_Base $model, array $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = [0, $limit_parts[0]];
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base             $model
-     * @param array                $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request|null $rest_request
-     * @param string|null          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     */
-    public function createEntityFromWpdbResult(
-        EEM_Base $model,
-        array $db_row,
-        ?WP_REST_Request $rest_request,
-        string $deprecated = null
-    ): array {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $current_user_full_access_to_entity = $model->currentUserCan(
-            EEM_Base::caps_read_admin,
-            $model->deduce_fields_n_values_from_cols_n_values($db_row)
-        );
-        $entity_array                       = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array                       = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links']             = $this->getEntityLinks($model, $db_row, $entity_array);
-        // when it's a regular read request for a model with a password and the password wasn't provided
-        // remove the password protected fields
-        $has_protected_fields = false;
-        try {
-            $this->checkPassword(
-                $model,
-                $db_row,
-                $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                ),
-                $rest_request
-            );
-        } catch (RestPasswordRequiredException $e) {
-            if ($model->hasPassword()) {
-                // just remove protected fields
-                $has_protected_fields = true;
-                $entity_array         = Capabilities::filterOutPasswordProtectedFields(
-                    $entity_array,
-                    $model,
-                    $this->getModelVersionInfo()
-                );
-            } else {
-                // that's a problem. None of this should be accessible if no password was provided
-                throw $e;
-            }
-        }
-
-        $entity_array['_calculated_fields'] =
-            $this->getEntityCalculations($model, $db_row, $rest_request, $has_protected_fields);
-        $entity_array                       = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        // add an empty protected property for now. If it's still around after we remove everything the request didn't
-        // want, we'll populate it then. k?
-        $entity_array['_protected'] = [];
-        // remove any properties the request didn't want. This way _protected won't bother mentioning them
-        $entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
-        $entity_array =
-            $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row, $has_protected_fields);
-        // if they still wanted the _protected property, add it.
-        if (isset($entity_array['_protected'])) {
-            $entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
-        }
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        if (! $current_user_full_access_to_entity) {
-            $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-                $entity_array,
-                $model,
-                $rest_request->get_param('caps'),
-                $this->getModelVersionInfo()
-            );
-        } else {
-            $result_without_inaccessible_fields = $entity_array;
-        }
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-
-    /**
-     * Returns an array describing which fields can be protected, and which actually were removed this request
-     *
-     * @param EEM_Base $model
-     * @param array    $results_so_far
-     * @param bool     $protected
-     * @return array results
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
-    {
-        if (! $model->hasPassword() || ! $protected) {
-            return $results_so_far;
-        }
-        $password_field  = $model->getPasswordField();
-        $all_protected   = array_merge(
-            [$password_field->get_name()],
-            $password_field->protectedFields()
-        );
-        $fields_included = array_keys($results_so_far);
-        $fields_included = array_intersect(
-            $all_protected,
-            $fields_included
-        );
-        foreach ($fields_included as $field_name) {
-            $results_so_far['_protected'][] = $field_name;
-        }
-        return $results_so_far;
-    }
-
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws RestException
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, array $db_row): array
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post     = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname          = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif (
-                $this->isSubclassOfOne(
-                    $field_obj,
-                    $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-                )
-            ) {
-                $result[ $field_name ] = [
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                ];
-            } elseif (
-                $this->isSubclassOfOne(
-                    $field_obj,
-                    $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-                )
-            ) {
-                $result[ $field_name ] = [
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                ];
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ]          = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws RestException if $value contains a PHP object
-     * @throws EE_Error
-     */
-    protected function prepareFieldObjValueForJson(
-        EE_Model_Field_Base $field_obj,
-        $value,
-        string $format = 'normal'
-    ) {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row
-     * @param array           $entity_array
-     * @return array the _links item in the entity
-     * @throws EE_Error
-     * @throws EE_Error
-     * @global WP_REST_Server $wp_rest_server
-     */
-    protected function getEntityLinks(EEM_Base $model, array $db_row, array $entity_array): array
-    {
-        // add basic links
-        $links = [];
-        if ($model->has_primary_key_field()) {
-            $links['self'] = [
-                [
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ],
-            ];
-        }
-        $links['collection'] = [
-            [
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ],
-        ];
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part                                                      =
-                    Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
-                    [
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation,
-                    ],
-                ];
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param array           $entity_array
-     * @param array           $db_row
-     * @param boolean         $included_items_protected if the original item is password protected, don't include any
-     *                                                  related models.
-     * @return array the modified entity
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        array $entity_array,
-        array $db_row = [],
-        bool $included_items_protected = false
-    ): array {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    [
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                        'password'  => $rest_request->get_param('password'),
-                    ]
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                if (! $included_items_protected) {
-                    try {
-                        $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                            $primary_model_query_params,
-                            $relation_obj,
-                            $pretend_related_request
-                        );
-                    } catch (RestException $e) {
-                        $related_results = new WP_Error('entity_relations_error', $e->getMessage());
-                    }
-                } else {
-                    // they're protected, hide them.
-                    $related_results              = null;
-                    $entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
-                }
-                if ($related_results instanceof WP_Error) {
-                    $related_results = $relation_obj instanceof EE_Belongs_To_Relation
-                        ? null
-                        : [];
-                }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * If the user has requested only specific properties (including meta properties like _links or _protected)
-     * remove everything else.
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $rest_request
-     * @param                 $entity_array
-     * @return array
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    protected function includeOnlyRequestedProperties(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array
-    ): array {
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (
-            ! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $model_names
-     * @return array
-     */
-    private function removeModelNamesFromArray(array $model_names): array
-    {
-        return array_diff($model_names, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @param boolean         $row_is_protected whether this row is password protected or not
-     * @return stdClass the _calculations item in the entity
-     * @throws RestException if a default value has a PHP object, which should never do (and if we
-     * @throws EE_Error
-     *                                          did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations(
-        EEM_Base $model,
-        array $wpdb_row,
-        WP_REST_Request $rest_request,
-        bool $row_is_protected = false
-    ): stdClass {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new stdClass();
-        $protected_fields            = [];
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                // it's password protected, so they shouldn't be able to read this. Remove the value
-                $schema = $this->fields_calculator->getJsonSchemaForModel($model);
-                if (
-                    $row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']
-                ) {
-                    $calculated_value   = null;
-                    $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
-                            case 'boolean':
-                                $calculated_value = false;
-                                break;
-                            case 'integer':
-                                $calculated_value = 0;
-                                break;
-                            case 'string':
-                                $calculated_value = '';
-                                break;
-                            case 'array':
-                                $calculated_value = [];
-                                break;
-                            case 'object':
-                                $calculated_value = new stdClass();
-                                break;
-                        }
-                    }
-                } else {
-                    $calculated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        null,
-                        $this->fields_calculator->retrieveCalculatedFieldValue(
-                            $model,
-                            $field_to_calculate,
-                            $wpdb_row,
-                            $rest_request,
-                            $this
-                        ),
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage()
-                );
-            }
-        }
-        $calculated_fields_to_return->_protected = $protected_fields;
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function getVersionedLinkTo(string $link_part_after_version_and_slash): string
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                 $relation_name
-     * @param EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName(string $relation_name, EE_Model_Relation_Base $relation_obj): string
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getEntityFromModel(EEM_Base $model, WP_REST_Request $request): array
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext(string $context): string
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return EEM_Base::caps_read;
-        }
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validateDefaultQueryParams($default_query_params): string
-    {
-        $valid_default_where_conditions_for_api_calls = [
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-        ];
-        if (! $default_query_params) {
-            $default_query_params = EEM_Base::default_where_conditions_all;
-        }
-        if (
-            in_array(
-                $default_query_params,
-                $valid_default_where_conditions_for_api_calls,
-                true
-            )
-        ) {
-            return $default_query_params;
-        }
-        return EEM_Base::default_where_conditions_all;
-    }
-
-
-    /**
-     * Translates API filter get parameter into model query params @param EEM_Base $model
-     *
-     * @param array $query_params
-     * @return array model query params (@see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
-     *               or FALSE to indicate that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws RestException
-     * @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
-     *               Note: right now the query parameter keys for fields (and related fields) can be left as-is, but
-     *               it's quite possible this will change someday. Also, this method's contents might be candidate for
-     *               moving to Model_Data_Translator
-     *
-     */
-    public function createModelQueryParams(EEM_Base $model, array $query_params): array
-    {
-        $model_query_params = [];
-        if (isset($query_params['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order_by'])) {
-            $order_by = $query_params['order_by'];
-        } elseif (isset($query_params['orderby'])) {
-            $order_by = $query_params['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_params['group_by'])) {
-            $group_by = $query_params['group_by'];
-        } elseif (isset($query_params['groupby'])) {
-            $group_by = $query_params['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_params['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order'])) {
-            $model_query_params['order'] = $query_params['order'];
-        }
-        if (isset($query_params['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_params['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
-                $limit_array = explode(',', (string) $query_params['limit']);
-            } else {
-                $limit_array = $query_params['limit'];
-            }
-            $sanitized_limit = [];
-            foreach ($limit_array as $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            esc_html__(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_params['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_params['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_params['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_params['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_params['default_where_conditions']
-            );
-        }
-        // if this is a model protected by a password on another model, exclude the password protected
-        // entities by default. But if they passed in a password, try to show them all. If the password is wrong,
-        // though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
-        if (
-            ! $model->hasPassword()
-            && $model->restrictedByRelatedModelPassword()
-            && $model_query_params['caps'] === EEM_Base::caps_read
-        ) {
-            if (empty($query_params['password'])) {
-                $model_query_params['exclude_protected'] = true;
-            }
-        }
-
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     * @deprecated
-     */
-    public function prepareRestQueryParamsKeyForModels(EEM_Base $model, array $query_params): array
-    {
-        $model_ready_query_params = [];
-        foreach ($query_params as $key => $value) {
-            $model_ready_query_params[ $key ] = is_array($value)
-                ? $this->prepareRestQueryParamsKeyForModels($model, $value)
-                : $value;
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return array
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     */
-    public function prepareRestQueryParamsValuesForModels(EEM_Base $model, array $query_params): array
-    {
-        $model_ready_query_params = [];
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, string $prefix): array
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = [];
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents    = array_filter($exploded_contents);
-        $contents_with_prefix = [];
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @param array|string $include_string @see Read:handle_request_get_all
-     * @param string|null  $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                                     the fields for that model, with the model's name removed from each.
-     *                                     If $include_string was blank or '*' returns an empty array
-     * @throws EE_Error
-     * @throws EE_Error
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     *                                     Deprecated because its return values were really quite confusing- sometimes
-     *                                     it returned an empty array (when the include string was blank or '*') or
-     *                                     sometimes it returned array('*') (when you provided a model and a model of
-     *                                     that kind was found). Parses the $include_string so we fetch all the field
-     *                                     names relating to THIS model
-     *                                     (ie have NO period in them), or for the provided model (ie start with the
-     *                                     model name and then a period).
-     */
-    public function extractIncludesForThisModel($include_string, string $model_name = ''): array
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return [];
-        }
-        $includes                    = explode(',', $include_string);
-        $extracted_fields_to_include = [];
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (
-                    strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null): array
-    {
-        $query_params = [[$model->primary_key_name() => $request->get_param('id')], 'limit' => 1];
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params         = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                reset($model_rows),
-                $request
-            );
-        } else {
-            // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            if ($model->exists($query_params)) {
-                // you got shafted- it existed but we didn't want to tell you!
-                throw new RestException(
-                    'rest_user_cannot_' . $context,
-                    sprintf(
-                        esc_html__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        $lowercase_model_name,
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    ['status' => 403]
-                );
-            } else {
-                // it's not you. It just doesn't exist
-                throw new RestException(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(esc_html__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    ['status' => 404]
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Checks that if this content requires a password to be read, that it's been provided and is correct.
-     *
-     * @param EEM_Base        $model
-     * @param array           $model_row
-     * @param array           $query_params Adds 'default_where_conditions' => 'minimum'
-     *                                      to ensure we don't confuse trashed with password protected.
-     * @param WP_REST_Request $request
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestPasswordRequiredException
-     * @throws RestPasswordIncorrectException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @since 4.9.74.p
-     */
-    protected function checkPassword(EEM_Base $model, array $model_row, array $query_params, WP_REST_Request $request)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        // stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
-        // or you don't.
-        $request_caps = $request->get_param('caps');
-        if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
-            return;
-        }
-        // if this entity requires a password, they better give it and it better be right!
-        if (
-            $model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
-        ) {
-            if (empty($request['password'])) {
-                throw new RestPasswordRequiredException();
-            }
-            if (
-                ! hash_equals(
-                    $model_row[ $model->getPasswordField()->get_qualified_column() ],
-                    $request['password']
-                )
-            ) {
-                throw new RestPasswordIncorrectException();
-            }
-        } elseif (
-            // wait! maybe this content is password protected
-            $model->restrictedByRelatedModelPassword()
-            && $request->get_param('caps') === EEM_Base::caps_read
-        ) {
-            $password_supplied = $request->get_param('password');
-            if (empty($password_supplied)) {
-                $query_params['exclude_protected'] = true;
-                if (! $model->exists($query_params)) {
-                    throw new RestPasswordRequiredException();
-                }
-            } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (! $model->exists($query_params)) {
-                    throw new RestPasswordIncorrectException();
-                }
-            }
-        }
-    }
-
-
-    private static function endpointParsingError(string $model_name): WP_Error
-    {
-        return new WP_Error(
-            'endpoint_parsing_error',
-            sprintf(
-                esc_html__(
-                    'There is no model for endpoint %s. Please contact event espresso support',
-                    'event_espresso'
-                ),
-                $model_name
-            )
-        );
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 *
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * @param string $version
+	 * @return Read
+	 * @since $VID:$
+	 */
+	public static function getModelReadController(string $version): Read
+	{
+		/** @var Read $controller */
+		$controller = LoaderFactory::getLoader()->getNew(Read::class);
+		$controller->setRequestedVersion($version);
+		return $controller;
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleRequestGetAll(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name
+	): WP_REST_Response {
+		$controller = Read::getModelReadController($version);
+		try {
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(Read::endpointParsingError($model_name));
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version    The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleSchemaRequest(string $version, string $model_name): array
+	{
+		$controller = Read::getModelReadController($version);
+		try {
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return [];
+			}
+			// get the model for this version
+			$model        = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema(
+				$model,
+				LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields')
+			);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return [];
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema): array
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws RestException  if a default value has a PHP object, which we should never do
+	 *                                  (but if we did, let's know about it ASAP, so let the exception bubble up)
+	 * @throws EE_Error
+	 *
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest(): string
+	{
+		if (
+			isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			/** @var RequestInterface $request */
+			$request = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			return $request->serverParamIsSet('PATH_INFO')
+				? $request->getServerParam('PATH_INFO')
+				: '/';
+		}
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetOne(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name
+	): WP_REST_Response {
+		$controller = Read::getModelReadController($version);
+		try {
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(Read::endpointParsingError($model_name));
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @param string          $related_model_name
+	 * @return WP_REST_Response
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		string $version,
+		string $model_name,
+		string $related_model_name
+	): WP_REST_Response {
+		$controller = Read::getModelReadController($version);
+		try {
+			$main_model = $controller->validateModel($model_name);
+			$controller->validateModel($related_model_name);
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 */
+	public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				['status' => 403]
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results      = $model->get_all_wpdb_results($query_params);
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                  $primary_model_query_params  query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request        $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws ModelConfigurationException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams(
+		array $primary_model_query_params,
+		EE_Model_Relation_Base $relation,
+		WP_REST_Request $request
+	): array {
+		$context       = $this->validateContext($request->get_param('caps'));
+		$model         = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = [];
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = [
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		];
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params          = $primary_model_query_params;
+		$restricted_query_params['caps']  = $context;
+		$restricted_query_params['limit'] = 1;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		$primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		$primary_model_row  = null;
+		if (is_array($primary_model_rows)) {
+			$primary_model_row = reset($primary_model_rows);
+		}
+		if (
+			! (
+				$primary_model_row
+				&& Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					esc_html__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				['status' => 403]
+			);
+		}
+
+		$this->checkPassword(
+			$model,
+			$primary_model_row,
+			$restricted_query_params,
+			$request
+		);
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps']                     = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results      = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = [];
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result     = array_merge($join_model_result, $nice_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                 $id the ID of the thing we are fetching related stuff from
+	 * @param EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request        $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getEntitiesFromRelation(
+		string $id,
+		EE_Model_Relation_Base $relation,
+		WP_REST_Request $request
+	): array {
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		// can we edit that main item?
+		// if not, show nothing but an error
+		// otherwise, please proceed
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			[
+				[
+					$relation->get_this_model()->primary_key_name() => $id,
+				],
+			],
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function setHeadersFromQueryParams(EEM_Base $model, array $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = [0, $limit_parts[0]];
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base             $model
+	 * @param array                $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request|null $rest_request
+	 * @param string|null          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 */
+	public function createEntityFromWpdbResult(
+		EEM_Base $model,
+		array $db_row,
+		?WP_REST_Request $rest_request,
+		string $deprecated = null
+	): array {
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$current_user_full_access_to_entity = $model->currentUserCan(
+			EEM_Base::caps_read_admin,
+			$model->deduce_fields_n_values_from_cols_n_values($db_row)
+		);
+		$entity_array                       = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array                       = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links']             = $this->getEntityLinks($model, $db_row, $entity_array);
+		// when it's a regular read request for a model with a password and the password wasn't provided
+		// remove the password protected fields
+		$has_protected_fields = false;
+		try {
+			$this->checkPassword(
+				$model,
+				$db_row,
+				$model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				),
+				$rest_request
+			);
+		} catch (RestPasswordRequiredException $e) {
+			if ($model->hasPassword()) {
+				// just remove protected fields
+				$has_protected_fields = true;
+				$entity_array         = Capabilities::filterOutPasswordProtectedFields(
+					$entity_array,
+					$model,
+					$this->getModelVersionInfo()
+				);
+			} else {
+				// that's a problem. None of this should be accessible if no password was provided
+				throw $e;
+			}
+		}
+
+		$entity_array['_calculated_fields'] =
+			$this->getEntityCalculations($model, $db_row, $rest_request, $has_protected_fields);
+		$entity_array                       = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		// add an empty protected property for now. If it's still around after we remove everything the request didn't
+		// want, we'll populate it then. k?
+		$entity_array['_protected'] = [];
+		// remove any properties the request didn't want. This way _protected won't bother mentioning them
+		$entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
+		$entity_array =
+			$this->includeRequestedModels($model, $rest_request, $entity_array, $db_row, $has_protected_fields);
+		// if they still wanted the _protected property, add it.
+		if (isset($entity_array['_protected'])) {
+			$entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
+		}
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		if (! $current_user_full_access_to_entity) {
+			$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+				$entity_array,
+				$model,
+				$rest_request->get_param('caps'),
+				$this->getModelVersionInfo()
+			);
+		} else {
+			$result_without_inaccessible_fields = $entity_array;
+		}
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+
+	/**
+	 * Returns an array describing which fields can be protected, and which actually were removed this request
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $results_so_far
+	 * @param bool     $protected
+	 * @return array results
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
+	{
+		if (! $model->hasPassword() || ! $protected) {
+			return $results_so_far;
+		}
+		$password_field  = $model->getPasswordField();
+		$all_protected   = array_merge(
+			[$password_field->get_name()],
+			$password_field->protectedFields()
+		);
+		$fields_included = array_keys($results_so_far);
+		$fields_included = array_intersect(
+			$all_protected,
+			$fields_included
+		);
+		foreach ($fields_included as $field_name) {
+			$results_so_far['_protected'][] = $field_name;
+		}
+		return $results_so_far;
+	}
+
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws RestException
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, array $db_row): array
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post     = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname          = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif (
+				$this->isSubclassOfOne(
+					$field_obj,
+					$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+				)
+			) {
+				$result[ $field_name ] = [
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				];
+			} elseif (
+				$this->isSubclassOfOne(
+					$field_obj,
+					$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+				)
+			) {
+				$result[ $field_name ] = [
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				];
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ]          = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws RestException if $value contains a PHP object
+	 * @throws EE_Error
+	 */
+	protected function prepareFieldObjValueForJson(
+		EE_Model_Field_Base $field_obj,
+		$value,
+		string $format = 'normal'
+	) {
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row
+	 * @param array           $entity_array
+	 * @return array the _links item in the entity
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @global WP_REST_Server $wp_rest_server
+	 */
+	protected function getEntityLinks(EEM_Base $model, array $db_row, array $entity_array): array
+	{
+		// add basic links
+		$links = [];
+		if ($model->has_primary_key_field()) {
+			$links['self'] = [
+				[
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				],
+			];
+		}
+		$links['collection'] = [
+			[
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			],
+		];
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part                                                      =
+					Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
+					[
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation,
+					],
+				];
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array           $entity_array
+	 * @param array           $db_row
+	 * @param boolean         $included_items_protected if the original item is password protected, don't include any
+	 *                                                  related models.
+	 * @return array the modified entity
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		array $entity_array,
+		array $db_row = [],
+		bool $included_items_protected = false
+	): array {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					[
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+						'password'  => $rest_request->get_param('password'),
+					]
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				if (! $included_items_protected) {
+					try {
+						$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+							$primary_model_query_params,
+							$relation_obj,
+							$pretend_related_request
+						);
+					} catch (RestException $e) {
+						$related_results = new WP_Error('entity_relations_error', $e->getMessage());
+					}
+				} else {
+					// they're protected, hide them.
+					$related_results              = null;
+					$entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
+				}
+				if ($related_results instanceof WP_Error) {
+					$related_results = $relation_obj instanceof EE_Belongs_To_Relation
+						? null
+						: [];
+				}
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * If the user has requested only specific properties (including meta properties like _links or _protected)
+	 * remove everything else.
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $rest_request
+	 * @param                 $entity_array
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	protected function includeOnlyRequestedProperties(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array
+	): array {
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (
+			! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $model_names
+	 * @return array
+	 */
+	private function removeModelNamesFromArray(array $model_names): array
+	{
+		return array_diff($model_names, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @param boolean         $row_is_protected whether this row is password protected or not
+	 * @return stdClass the _calculations item in the entity
+	 * @throws RestException if a default value has a PHP object, which should never do (and if we
+	 * @throws EE_Error
+	 *                                          did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations(
+		EEM_Base $model,
+		array $wpdb_row,
+		WP_REST_Request $rest_request,
+		bool $row_is_protected = false
+	): stdClass {
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new stdClass();
+		$protected_fields            = [];
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				// it's password protected, so they shouldn't be able to read this. Remove the value
+				$schema = $this->fields_calculator->getJsonSchemaForModel($model);
+				if (
+					$row_is_protected
+					&& isset($schema['properties'][ $field_to_calculate ]['protected'])
+					&& $schema['properties'][ $field_to_calculate ]['protected']
+				) {
+					$calculated_value   = null;
+					$protected_fields[] = $field_to_calculate;
+					if ($schema['properties'][ $field_to_calculate ]['type']) {
+						switch ($schema['properties'][ $field_to_calculate ]['type']) {
+							case 'boolean':
+								$calculated_value = false;
+								break;
+							case 'integer':
+								$calculated_value = 0;
+								break;
+							case 'string':
+								$calculated_value = '';
+								break;
+							case 'array':
+								$calculated_value = [];
+								break;
+							case 'object':
+								$calculated_value = new stdClass();
+								break;
+						}
+					}
+				} else {
+					$calculated_value = ModelDataTranslator::prepareFieldValueForJson(
+						null,
+						$this->fields_calculator->retrieveCalculatedFieldValue(
+							$model,
+							$field_to_calculate,
+							$wpdb_row,
+							$rest_request,
+							$this
+						),
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage()
+				);
+			}
+		}
+		$calculated_fields_to_return->_protected = $protected_fields;
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function getVersionedLinkTo(string $link_part_after_version_and_slash): string
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                 $relation_name
+	 * @param EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName(string $relation_name, EE_Model_Relation_Base $relation_obj): string
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getEntityFromModel(EEM_Base $model, WP_REST_Request $request): array
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext(string $context): string
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return EEM_Base::caps_read;
+		}
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validateDefaultQueryParams($default_query_params): string
+	{
+		$valid_default_where_conditions_for_api_calls = [
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+		];
+		if (! $default_query_params) {
+			$default_query_params = EEM_Base::default_where_conditions_all;
+		}
+		if (
+			in_array(
+				$default_query_params,
+				$valid_default_where_conditions_for_api_calls,
+				true
+			)
+		) {
+			return $default_query_params;
+		}
+		return EEM_Base::default_where_conditions_all;
+	}
+
+
+	/**
+	 * Translates API filter get parameter into model query params @param EEM_Base $model
+	 *
+	 * @param array $query_params
+	 * @return array model query params (@see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
+	 *               or FALSE to indicate that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
+	 *               Note: right now the query parameter keys for fields (and related fields) can be left as-is, but
+	 *               it's quite possible this will change someday. Also, this method's contents might be candidate for
+	 *               moving to Model_Data_Translator
+	 *
+	 */
+	public function createModelQueryParams(EEM_Base $model, array $query_params): array
+	{
+		$model_query_params = [];
+		if (isset($query_params['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order_by'])) {
+			$order_by = $query_params['order_by'];
+		} elseif (isset($query_params['orderby'])) {
+			$order_by = $query_params['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_params['group_by'])) {
+			$group_by = $query_params['group_by'];
+		} elseif (isset($query_params['groupby'])) {
+			$group_by = $query_params['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_params['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order'])) {
+			$model_query_params['order'] = $query_params['order'];
+		}
+		if (isset($query_params['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_params['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_params['limit'])) {
+				$limit_array = explode(',', (string) $query_params['limit']);
+			} else {
+				$limit_array = $query_params['limit'];
+			}
+			$sanitized_limit = [];
+			foreach ($limit_array as $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							esc_html__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_params['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_params['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_params['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_params['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_params['default_where_conditions']
+			);
+		}
+		// if this is a model protected by a password on another model, exclude the password protected
+		// entities by default. But if they passed in a password, try to show them all. If the password is wrong,
+		// though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
+		if (
+			! $model->hasPassword()
+			&& $model->restrictedByRelatedModelPassword()
+			&& $model_query_params['caps'] === EEM_Base::caps_read
+		) {
+			if (empty($query_params['password'])) {
+				$model_query_params['exclude_protected'] = true;
+			}
+		}
+
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 * @deprecated
+	 */
+	public function prepareRestQueryParamsKeyForModels(EEM_Base $model, array $query_params): array
+	{
+		$model_ready_query_params = [];
+		foreach ($query_params as $key => $value) {
+			$model_ready_query_params[ $key ] = is_array($value)
+				? $this->prepareRestQueryParamsKeyForModels($model, $value)
+				: $value;
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return array
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 */
+	public function prepareRestQueryParamsValuesForModels(EEM_Base $model, array $query_params): array
+	{
+		$model_ready_query_params = [];
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, string $prefix): array
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = [];
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents    = array_filter($exploded_contents);
+		$contents_with_prefix = [];
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @param array|string $include_string @see Read:handle_request_get_all
+	 * @param string|null  $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                                     the fields for that model, with the model's name removed from each.
+	 *                                     If $include_string was blank or '*' returns an empty array
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 *                                     Deprecated because its return values were really quite confusing- sometimes
+	 *                                     it returned an empty array (when the include string was blank or '*') or
+	 *                                     sometimes it returned array('*') (when you provided a model and a model of
+	 *                                     that kind was found). Parses the $include_string so we fetch all the field
+	 *                                     names relating to THIS model
+	 *                                     (ie have NO period in them), or for the provided model (ie start with the
+	 *                                     model name and then a period).
+	 */
+	public function extractIncludesForThisModel($include_string, string $model_name = ''): array
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return [];
+		}
+		$includes                    = explode(',', $include_string);
+		$extracted_fields_to_include = [];
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (
+					strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null): array
+	{
+		$query_params = [[$model->primary_key_name() => $request->get_param('id')], 'limit' => 1];
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params         = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				reset($model_rows),
+				$request
+			);
+		} else {
+			// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			if ($model->exists($query_params)) {
+				// you got shafted- it existed but we didn't want to tell you!
+				throw new RestException(
+					'rest_user_cannot_' . $context,
+					sprintf(
+						esc_html__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						$lowercase_model_name,
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					['status' => 403]
+				);
+			} else {
+				// it's not you. It just doesn't exist
+				throw new RestException(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(esc_html__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					['status' => 404]
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Checks that if this content requires a password to be read, that it's been provided and is correct.
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $model_row
+	 * @param array           $query_params Adds 'default_where_conditions' => 'minimum'
+	 *                                      to ensure we don't confuse trashed with password protected.
+	 * @param WP_REST_Request $request
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestPasswordRequiredException
+	 * @throws RestPasswordIncorrectException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @since 4.9.74.p
+	 */
+	protected function checkPassword(EEM_Base $model, array $model_row, array $query_params, WP_REST_Request $request)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		// stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
+		// or you don't.
+		$request_caps = $request->get_param('caps');
+		if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
+			return;
+		}
+		// if this entity requires a password, they better give it and it better be right!
+		if (
+			$model->hasPassword()
+			&& $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
+		) {
+			if (empty($request['password'])) {
+				throw new RestPasswordRequiredException();
+			}
+			if (
+				! hash_equals(
+					$model_row[ $model->getPasswordField()->get_qualified_column() ],
+					$request['password']
+				)
+			) {
+				throw new RestPasswordIncorrectException();
+			}
+		} elseif (
+			// wait! maybe this content is password protected
+			$model->restrictedByRelatedModelPassword()
+			&& $request->get_param('caps') === EEM_Base::caps_read
+		) {
+			$password_supplied = $request->get_param('password');
+			if (empty($password_supplied)) {
+				$query_params['exclude_protected'] = true;
+				if (! $model->exists($query_params)) {
+					throw new RestPasswordRequiredException();
+				}
+			} else {
+				$query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
+				if (! $model->exists($query_params)) {
+					throw new RestPasswordIncorrectException();
+				}
+			}
+		}
+	}
+
+
+	private static function endpointParsingError(string $model_name): WP_Error
+	{
+		return new WP_Error(
+			'endpoint_parsing_error',
+			sprintf(
+				esc_html__(
+					'There is no model for endpoint %s. Please contact event espresso support',
+					'event_espresso'
+				),
+				$model_name
+			)
+		);
+	}
 }

Spacing +63 added lines, -63 removed lines

@@ -100,7 +100,7 @@ 
     ): WP_REST_Response {
         $controller = Read::getModelReadController($version);
         try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(Read::endpointParsingError($model_name));
             }
             return $controller->sendResponse(
@@ -129,7 +129,7 @@ 
     {
         $controller = Read::getModelReadController($version);
         try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return [];
             }
             // get the model for this version
@@ -193,11 +193,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema): array
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -206,9 +206,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -230,9 +230,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema): array
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -282,7 +282,7 @@ 
     ): WP_REST_Response {
         $controller = Read::getModelReadController($version);
         try {
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(Read::endpointParsingError($model_name));
             }
             return $controller->sendResponse(
@@ -349,7 +349,7 @@ 
     public function getEntitiesFromModel(EEM_Base $model, WP_REST_Request $request): array
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -361,7 +361,7 @@ 
                 ['status' => 403]
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -405,7 +405,7 @@ 
         $context       = $this->validateContext($request->get_param('caps'));
         $model         = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = [];
         }
         // check if they can access the 1st model object
@@ -469,13 +469,13 @@ 
         );
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps']                     = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -495,7 +495,7 @@ 
                     $result,
                     $request
                 );
-                $joined_result     = array_merge($join_model_result, $nice_result);
+                $joined_result = array_merge($join_model_result, $nice_result);
                 // but keep the meta stuff from the main model
                 if (isset($nice_result['meta'])) {
                     $joined_result['meta'] = $nice_result['meta'];
@@ -530,7 +530,7 @@ 
         EE_Model_Relation_Base $relation,
         WP_REST_Request $request
     ): array {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -577,7 +577,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -619,7 +619,7 @@ 
         ?WP_REST_Request $rest_request,
         string $deprecated = null
     ): array {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -696,7 +696,7 @@ 
             $rest_request,
             $this
         );
-        if (! $current_user_full_access_to_entity) {
+        if ( ! $current_user_full_access_to_entity) {
             $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
                 $entity_array,
                 $model,
@@ -731,7 +731,7 @@ 
      */
     protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
     {
-        if (! $model->hasPassword() || ! $protected) {
+        if ( ! $model->hasPassword() || ! $protected) {
             return $results_so_far;
         }
         $password_field  = $model->getPasswordField();
@@ -780,8 +780,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post     = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof WP_Post) {
+            $post     = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -791,7 +791,7 @@ 
                     )
                 );
             }
-            $model_object_classname          = 'EE_' . $model->get_this_model_name();
+            $model_object_classname          = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -802,14 +802,14 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif (
                 $this->isSubclassOfOne(
                     $field_obj,
                     $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
                 )
             ) {
-                $result[ $field_name ] = [
+                $result[$field_name] = [
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 ];
@@ -819,7 +819,7 @@ 
                     $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
                 )
             ) {
-                $result[ $field_name ] = [
+                $result[$field_name] = [
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 ];
@@ -850,10 +850,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ]          = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name]          = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -911,7 +911,7 @@ 
     protected function addExtraFields(EEM_Base $model, array $db_row, array $entity_array): array
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -938,7 +938,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ],
             ];
@@ -955,12 +955,12 @@ 
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part                                                      =
                     Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = [
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = [
                     [
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -994,12 +994,12 @@ 
         bool $included_items_protected = false
     ): array {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
         foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include   = $this->explodeAndGetItemsPrefixedWith(
+            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
                 $rest_request->get_param('include'),
                 $relation_name
             );
@@ -1027,7 +1027,7 @@ 
                         $model->deduce_fields_n_values_from_cols_n_values($db_row)
                     )
                 );
-                if (! $included_items_protected) {
+                if ( ! $included_items_protected) {
                     try {
                         $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
                             $primary_model_query_params,
@@ -1047,7 +1047,7 @@ 
                         ? null
                         : [];
                 }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results;
             }
         }
         return $entity_array;
@@ -1134,13 +1134,13 @@ 
                 $schema = $this->fields_calculator->getJsonSchemaForModel($model);
                 if (
                     $row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']
+                    && isset($schema['properties'][$field_to_calculate]['protected'])
+                    && $schema['properties'][$field_to_calculate]['protected']
                 ) {
                     $calculated_value   = null;
                     $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
+                    if ($schema['properties'][$field_to_calculate]['type']) {
+                        switch ($schema['properties'][$field_to_calculate]['type']) {
                             case 'boolean':
                                 $calculated_value = false;
                                 break;
@@ -1254,7 +1254,7 @@ 
      */
     public function validateContext(string $context): string
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1279,7 +1279,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         ];
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = EEM_Base::default_where_conditions_all;
         }
         if (
@@ -1366,14 +1366,14 @@ 
         }
         if (isset($query_params['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
+            if ( ! is_array($query_params['limit'])) {
                 $limit_array = explode(',', (string) $query_params['limit']);
             } else {
                 $limit_array = $query_params['limit'];
             }
             $sanitized_limit = [];
             foreach ($limit_array as $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             esc_html__(
@@ -1431,7 +1431,7 @@ 
     {
         $model_ready_query_params = [];
         foreach ($query_params as $key => $value) {
-            $model_ready_query_params[ $key ] = is_array($value)
+            $model_ready_query_params[$key] = is_array($value)
                 ? $this->prepareRestQueryParamsKeyForModels($model, $value)
                 : $value;
         }
@@ -1450,9 +1450,9 @@ 
         $model_ready_query_params = [];
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1484,17 +1484,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1536,9 +1536,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name         = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name         = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1581,7 +1581,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 reset($model_rows),
@@ -1593,7 +1593,7 @@ 
             if ($model->exists($query_params)) {
                 // you got shafted- it existed but we didn't want to tell you!
                 throw new RestException(
-                    'rest_user_cannot_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         esc_html__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,
@@ -1647,14 +1647,14 @@ 
         // if this entity requires a password, they better give it and it better be right!
         if (
             $model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== ''
+            && $model_row[$model->getPasswordField()->get_qualified_column()] !== ''
         ) {
             if (empty($request['password'])) {
                 throw new RestPasswordRequiredException();
             }
             if (
                 ! hash_equals(
-                    $model_row[ $model->getPasswordField()->get_qualified_column() ],
+                    $model_row[$model->getPasswordField()->get_qualified_column()],
                     $request['password']
                 )
             ) {
@@ -1668,12 +1668,12 @@ 
             $password_supplied = $request->get_param('password');
             if (empty($password_supplied)) {
                 $query_params['exclude_protected'] = true;
-                if (! $model->exists($query_params)) {
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordRequiredException();
                 }
             } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (! $model->exists($query_params)) {
+                $query_params[0][$model->modelChainAndPassword()] = $password_supplied;
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordIncorrectException();
                 }
             }

core/libraries/rest_api/controllers/model/Base.php

Indentation +79 added lines, -79 removed lines

@@ -18,92 +18,92 @@
  */
 class Base extends Controller_Base
 {
-    /**
-     * Holds reference to the model version info, which knows the requested version
-     *
-     * @var ModelVersionInfo
-     */
-    protected $model_version_info;
+	/**
+	 * Holds reference to the model version info, which knows the requested version
+	 *
+	 * @var ModelVersionInfo
+	 */
+	protected $model_version_info;
 
 
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion(string $version)
-    {
-        parent::setRequestedVersion($version);
-        $this->model_version_info = new ModelVersionInfo($version);
-    }
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion(string $version)
+	{
+		parent::setRequestedVersion($version);
+		$this->model_version_info = new ModelVersionInfo($version);
+	}
 
 
-    /**
-     * Gets the object that should be used for getting any info from the models,
-     * because it's takes the requested and current core version into account
-     *
-     * @return ModelVersionInfo
-     * @throws EE_Error
-     */
-    public function getModelVersionInfo(): ModelVersionInfo
-    {
-        if (! $this->model_version_info) {
-            throw new EE_Error(
-                esc_html__(
-                    'Cannot use model version info before setting the requested version in the controller',
-                    'event_espresso'
-                )
-            );
-        }
-        return $this->model_version_info;
-    }
+	/**
+	 * Gets the object that should be used for getting any info from the models,
+	 * because it's takes the requested and current core version into account
+	 *
+	 * @return ModelVersionInfo
+	 * @throws EE_Error
+	 */
+	public function getModelVersionInfo(): ModelVersionInfo
+	{
+		if (! $this->model_version_info) {
+			throw new EE_Error(
+				esc_html__(
+					'Cannot use model version info before setting the requested version in the controller',
+					'event_espresso'
+				)
+			);
+		}
+		return $this->model_version_info;
+	}
 
 
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function isSubclassOfOne($object, array $classnames): bool
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function isSubclassOfOne($object, array $classnames): bool
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
 
 
-    /**
-     * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
-     * exception. Must be called after `setRequestedVersion()`.
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws RestException
-     * @since 4.9.76.p
-     */
-    protected function validateModel(string $model_name): EEM_Base
-    {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-            throw new RestException(
-                'endpoint_parsing_error',
-                sprintf(
-                    esc_html__(
-                        'There is no model for endpoint %s. Please contact event espresso support',
-                        'event_espresso'
-                    ),
-                    $model_name
-                )
-            );
-        }
-        return $this->getModelVersionInfo()->loadModel($model_name);
-    }
+	/**
+	 * Verifies the model name provided was valid. If so, returns the model (as an object). Otherwise, throws an
+	 * exception. Must be called after `setRequestedVersion()`.
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @since 4.9.76.p
+	 */
+	protected function validateModel(string $model_name): EEM_Base
+	{
+		if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+			throw new RestException(
+				'endpoint_parsing_error',
+				sprintf(
+					esc_html__(
+						'There is no model for endpoint %s. Please contact event espresso support',
+						'event_espresso'
+					),
+					$model_name
+				)
+			);
+		}
+		return $this->getModelVersionInfo()->loadModel($model_name);
+	}
 }
 // End of file Base.php

Spacing +2 added lines, -2 removed lines

@@ -47,7 +47,7 @@ 
      */
     public function getModelVersionInfo(): ModelVersionInfo
     {
-        if (! $this->model_version_info) {
+        if ( ! $this->model_version_info) {
             throw new EE_Error(
                 esc_html__(
                     'Cannot use model version info before setting the requested version in the controller',
@@ -91,7 +91,7 @@ 
      */
     protected function validateModel(string $model_name): EEM_Base
     {
-        if (! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+        if ( ! $this->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
             throw new RestException(
                 'endpoint_parsing_error',
                 sprintf(

core/libraries/rest_api/controllers/Base.php

Indentation +329 added lines, -329 removed lines

@@ -21,333 +21,333 @@
  */
 class Base
 {
-    /**
-     * @deprecated use all-caps version
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_ee = 'X-EE-';
-
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_EE = 'X-EE-';
-
-    /**
-     * @deprecated use all-caps version instead
-     */
-    // @codingStandardsIgnoreStart
-    const header_prefix_for_wp = 'X-WP-';
-
-    // @codingStandardsIgnoreEnd
-
-    const HEADER_PREFIX_FOR_WP = 'X-WP-';
-
-    /**
-     * Contains debug info we'll send back in the response headers
-     *
-     * @var array
-     */
-    protected $debug_info = [];
-
-    /**
-     * Indicates whether or not the API is in debug mode
-     *
-     * @var boolean
-     */
-    protected $debug_mode = false;
-
-    /**
-     * Indicates the version that was requested
-     *
-     * @var string
-     */
-    protected $requested_version;
-
-    /**
-     * flat array of headers to send in the response
-     *
-     * @var array
-     */
-    protected $response_headers = [];
-
-
-    public function __construct()
-    {
-        $this->debug_mode = EED_Core_Rest_Api::debugMode();
-        // we are handling a REST request. Don't show a fancy HTML error message is any error comes up
-        add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
-    }
-
-
-    /**
-     * Sets the version the user requested
-     *
-     * @param string $version eg '4.8'
-     */
-    public function setRequestedVersion(string $version)
-    {
-        $this->requested_version = $version;
-    }
-
-
-    /**
-     * Sets some debug info that we'll send back in headers
-     *
-     * @param string       $key
-     * @param string|array $info
-     */
-    protected function setDebugInfo(string $key, $info)
-    {
-        $this->debug_info[ $key ] = $info;
-    }
-
-
-    /**
-     * Sets headers for the response
-     *
-     * @param string       $header_key    , excluding the "X-EE-" part
-     * @param array|string $value         if an array, multiple headers will be added, one
-     *                                    for each key in the array
-     * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
-     *                                    the standard WP one
-     */
-    protected function setResponseHeader(string $header_key, $value, bool $use_ee_prefix = true)
-    {
-        if (is_array($value)) {
-            foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
-            }
-        } else {
-            $prefix                                          =
-                $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
-        }
-    }
-
-
-    /**
-     * Returns a flat array of headers to be added to the response
-     *
-     * @return array
-     */
-    protected function getResponseHeaders(): array
-    {
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            $this->response_headers,
-            $this,
-            $this->requested_version
-        );
-    }
-
-
-    /**
-     * Adds error notices from EE_Error onto the provided \WP_Error
-     *
-     * @param WP_Error $wp_error_response
-     * @return WP_Error
-     */
-    protected function addEeErrorsToResponse(WP_Error $wp_error_response): WP_Error
-    {
-        $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
-            foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
-                $wp_error_response->add(
-                    sanitize_key($error_code),
-                    strip_tags($error_message)
-                );
-            }
-        }
-        return $wp_error_response;
-    }
-
-
-    /**
-     * Sends a response, but also makes sure to attach headers that
-     * are handy for debugging.
-     * Specifically, we assume folks will want to know what exactly was the DB query that got run,
-     * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
-     * the response, others?
-     *
-     * @param array|WP_Error|Exception|RestException $response
-     * @return WP_REST_Response
-     */
-    public function sendResponse($response): WP_REST_Response
-    {
-        if ($response instanceof RestException) {
-            $response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
-        }
-        if ($response instanceof Exception) {
-            $code     = $response->getCode() ?: 'error_occurred';
-            $response = new WP_Error($code, $response->getMessage());
-        }
-        if ($response instanceof WP_Error) {
-            $response      = $this->addEeErrorsToResponse($response);
-            $rest_response = $this->createRestResponseFromWpError($response);
-        } else {
-            $rest_response = new WP_REST_Response($response, 200);
-        }
-        $headers = [];
-        if ($this->debug_mode && is_array($this->debug_info)) {
-            foreach ($this->debug_info as $debug_key => $debug_info) {
-                if (is_array($debug_info)) {
-                    $debug_info = wp_json_encode($debug_info);
-                }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
-            }
-        }
-        $headers = array_merge(
-            $headers,
-            $this->getResponseHeaders(),
-            $this->getHeadersFromEeNotices()
-        );
-        $rest_response->set_headers($headers);
-        return $rest_response;
-    }
-
-
-    /**
-     * Converts the \WP_Error into `WP_REST_Response.
-     * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
-     * (which is protected)
-     *
-     * @param WP_Error $wp_error
-     * @return WP_REST_Response
-     */
-    protected function createRestResponseFromWpError(WP_Error $wp_error): WP_REST_Response
-    {
-        $error_data = $wp_error->get_error_data();
-        if (is_array($error_data) && isset($error_data['status'])) {
-            $status = $error_data['status'];
-        } else {
-            $status = 500;
-        }
-        $errors = [];
-        foreach ($wp_error->errors as $code => $messages) {
-            foreach ((array) $messages as $message) {
-                $errors[] = [
-                    'code'    => $code,
-                    'message' => $message,
-                    'data'    => $wp_error->get_error_data($code),
-                ];
-            }
-        }
-        $data = $errors[0] ?? [];
-        if (count($errors) > 1) {
-            // Remove the primary error.
-            array_shift($errors);
-            $data['additional_errors'] = $errors;
-        }
-        return new WP_REST_Response($data, $status);
-    }
-
-
-    /**
-     * Array of headers derived from EE success, attention, and error messages
-     *
-     * @return array
-     */
-    protected function getHeadersFromEeNotices(): array
-    {
-        $headers = [];
-        $notices = EE_Error::get_raw_notices();
-        foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
-                continue;
-            }
-            foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
-                          . EEH_Inflector::humanize($notice_type)
-                          . '['
-                          . $notice_code
-                          . ']' ] = strip_tags((string) $sub_notice);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
-            $headers,
-            $this->requested_version,
-            $notices
-        );
-    }
-
-
-    /**
-     * Finds which version of the API was requested given the route, and returns it.
-     * eg in a request to "my-site.com/wp-json/ee/v4.8.29/events/123" this would return
-     * "4.8.29".
-     * We should know hte requested version in this model though, so if no route is
-     * provided just use what we set earlier
-     *
-     * @param string|null $route
-     * @return string
-     * @throws EE_Error
-     */
-    public function getRequestedVersion(?string $route = null): string
-    {
-        if ($route === null) {
-            return $this->requested_version;
-        }
-        $matches = $this->parseRoute(
-            $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
-            ['version']
-        );
-        return $matches['version'] ?? EED_Core_Rest_Api::latest_rest_api_version();
-    }
-
-
-    /**
-     * Applies the regex to the route, then creates an array using the values of
-     * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
-     * For example, if you call
-     * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
-     * it will return array( 'version' => '4.8', 'model' => 'events' )
-     *
-     * @param string $route
-     * @param string $regex
-     * @param array  $match_keys EXCLUDING matching the entire regex
-     * @return array where  $match_keys are the keys (the first value of $match_keys
-     *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
-     *                           array( 'model', 'id' ), will, if the regex is successful, will return
-     *                           array( 'model' => 'foo', 'id' => 'bar' )
-     * @throws EE_Error if it couldn't be parsed
-     */
-    public function parseRoute(string $route, string $regex, array $match_keys): array
-    {
-        $indexed_matches = [];
-        $success         = preg_match($regex, $route, $matches);
-        if (is_array($matches)) {
-            // skip the overall regex match. Who cares
-            for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
-                    $success = false;
-                } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
-                }
-            }
-        }
-        if (! $success) {
-            throw new EE_Error(
-                esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
-                'endpoint_parsing_error'
-            );
-        }
-        return $indexed_matches;
-    }
-
-
-    /**
-     * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
-     *
-     * @param WP_REST_Request $request
-     * @return array
-     */
-    protected function getBodyParams(WP_REST_Request $request): array
-    {
-        // $request->get_params();
-        return array_merge(
-            (array) $request->get_body_params(),
-            (array) $request->get_json_params()
-        );
-    }
+	/**
+	 * @deprecated use all-caps version
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_ee = 'X-EE-';
+
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_EE = 'X-EE-';
+
+	/**
+	 * @deprecated use all-caps version instead
+	 */
+	// @codingStandardsIgnoreStart
+	const header_prefix_for_wp = 'X-WP-';
+
+	// @codingStandardsIgnoreEnd
+
+	const HEADER_PREFIX_FOR_WP = 'X-WP-';
+
+	/**
+	 * Contains debug info we'll send back in the response headers
+	 *
+	 * @var array
+	 */
+	protected $debug_info = [];
+
+	/**
+	 * Indicates whether or not the API is in debug mode
+	 *
+	 * @var boolean
+	 */
+	protected $debug_mode = false;
+
+	/**
+	 * Indicates the version that was requested
+	 *
+	 * @var string
+	 */
+	protected $requested_version;
+
+	/**
+	 * flat array of headers to send in the response
+	 *
+	 * @var array
+	 */
+	protected $response_headers = [];
+
+
+	public function __construct()
+	{
+		$this->debug_mode = EED_Core_Rest_Api::debugMode();
+		// we are handling a REST request. Don't show a fancy HTML error message is any error comes up
+		add_filter('FHEE__EE_Error__get_error__show_normal_exceptions', '__return_true');
+	}
+
+
+	/**
+	 * Sets the version the user requested
+	 *
+	 * @param string $version eg '4.8'
+	 */
+	public function setRequestedVersion(string $version)
+	{
+		$this->requested_version = $version;
+	}
+
+
+	/**
+	 * Sets some debug info that we'll send back in headers
+	 *
+	 * @param string       $key
+	 * @param string|array $info
+	 */
+	protected function setDebugInfo(string $key, $info)
+	{
+		$this->debug_info[ $key ] = $info;
+	}
+
+
+	/**
+	 * Sets headers for the response
+	 *
+	 * @param string       $header_key    , excluding the "X-EE-" part
+	 * @param array|string $value         if an array, multiple headers will be added, one
+	 *                                    for each key in the array
+	 * @param boolean      $use_ee_prefix whether to use the EE prefix on the header, or fallback to
+	 *                                    the standard WP one
+	 */
+	protected function setResponseHeader(string $header_key, $value, bool $use_ee_prefix = true)
+	{
+		if (is_array($value)) {
+			foreach ($value as $value_key => $value_value) {
+				$this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+			}
+		} else {
+			$prefix                                          =
+				$use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
+			$this->response_headers[ $prefix . $header_key ] = $value;
+		}
+	}
+
+
+	/**
+	 * Returns a flat array of headers to be added to the response
+	 *
+	 * @return array
+	 */
+	protected function getResponseHeaders(): array
+	{
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			$this->response_headers,
+			$this,
+			$this->requested_version
+		);
+	}
+
+
+	/**
+	 * Adds error notices from EE_Error onto the provided \WP_Error
+	 *
+	 * @param WP_Error $wp_error_response
+	 * @return WP_Error
+	 */
+	protected function addEeErrorsToResponse(WP_Error $wp_error_response): WP_Error
+	{
+		$notices_during_checkin = EE_Error::get_raw_notices();
+		if (! empty($notices_during_checkin['errors'])) {
+			foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
+				$wp_error_response->add(
+					sanitize_key($error_code),
+					strip_tags($error_message)
+				);
+			}
+		}
+		return $wp_error_response;
+	}
+
+
+	/**
+	 * Sends a response, but also makes sure to attach headers that
+	 * are handy for debugging.
+	 * Specifically, we assume folks will want to know what exactly was the DB query that got run,
+	 * what exactly was the Models query that got run, what capabilities came into play, what fields were omitted from
+	 * the response, others?
+	 *
+	 * @param array|WP_Error|Exception|RestException $response
+	 * @return WP_REST_Response
+	 */
+	public function sendResponse($response): WP_REST_Response
+	{
+		if ($response instanceof RestException) {
+			$response = new WP_Error($response->getStringCode(), $response->getMessage(), $response->getData());
+		}
+		if ($response instanceof Exception) {
+			$code     = $response->getCode() ?: 'error_occurred';
+			$response = new WP_Error($code, $response->getMessage());
+		}
+		if ($response instanceof WP_Error) {
+			$response      = $this->addEeErrorsToResponse($response);
+			$rest_response = $this->createRestResponseFromWpError($response);
+		} else {
+			$rest_response = new WP_REST_Response($response, 200);
+		}
+		$headers = [];
+		if ($this->debug_mode && is_array($this->debug_info)) {
+			foreach ($this->debug_info as $debug_key => $debug_info) {
+				if (is_array($debug_info)) {
+					$debug_info = wp_json_encode($debug_info);
+				}
+				$headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+			}
+		}
+		$headers = array_merge(
+			$headers,
+			$this->getResponseHeaders(),
+			$this->getHeadersFromEeNotices()
+		);
+		$rest_response->set_headers($headers);
+		return $rest_response;
+	}
+
+
+	/**
+	 * Converts the \WP_Error into `WP_REST_Response.
+	 * Mostly this is just a copy-and-paste from \WP_REST_Server::error_to_response
+	 * (which is protected)
+	 *
+	 * @param WP_Error $wp_error
+	 * @return WP_REST_Response
+	 */
+	protected function createRestResponseFromWpError(WP_Error $wp_error): WP_REST_Response
+	{
+		$error_data = $wp_error->get_error_data();
+		if (is_array($error_data) && isset($error_data['status'])) {
+			$status = $error_data['status'];
+		} else {
+			$status = 500;
+		}
+		$errors = [];
+		foreach ($wp_error->errors as $code => $messages) {
+			foreach ((array) $messages as $message) {
+				$errors[] = [
+					'code'    => $code,
+					'message' => $message,
+					'data'    => $wp_error->get_error_data($code),
+				];
+			}
+		}
+		$data = $errors[0] ?? [];
+		if (count($errors) > 1) {
+			// Remove the primary error.
+			array_shift($errors);
+			$data['additional_errors'] = $errors;
+		}
+		return new WP_REST_Response($data, $status);
+	}
+
+
+	/**
+	 * Array of headers derived from EE success, attention, and error messages
+	 *
+	 * @return array
+	 */
+	protected function getHeadersFromEeNotices(): array
+	{
+		$headers = [];
+		$notices = EE_Error::get_raw_notices();
+		foreach ($notices as $notice_type => $sub_notices) {
+			if (! is_array($sub_notices)) {
+				continue;
+			}
+			foreach ($sub_notices as $notice_code => $sub_notice) {
+				$headers[ 'X-EE4-Notices-'
+						  . EEH_Inflector::humanize($notice_type)
+						  . '['
+						  . $notice_code
+						  . ']' ] = strip_tags((string) $sub_notice);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_headers_from_ee_notices__return',
+			$headers,
+			$this->requested_version,
+			$notices
+		);
+	}
+
+
+	/**
+	 * Finds which version of the API was requested given the route, and returns it.
+	 * eg in a request to "my-site.com/wp-json/ee/v4.8.29/events/123" this would return
+	 * "4.8.29".
+	 * We should know hte requested version in this model though, so if no route is
+	 * provided just use what we set earlier
+	 *
+	 * @param string|null $route
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getRequestedVersion(?string $route = null): string
+	{
+		if ($route === null) {
+			return $this->requested_version;
+		}
+		$matches = $this->parseRoute(
+			$route,
+			'~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+			['version']
+		);
+		return $matches['version'] ?? EED_Core_Rest_Api::latest_rest_api_version();
+	}
+
+
+	/**
+	 * Applies the regex to the route, then creates an array using the values of
+	 * $match_keys as keys (but ignores the full pattern match). Returns the array of matches.
+	 * For example, if you call
+	 * parse_route( '/ee/v4.8/events', '~\/ee\/v([^/]*)\/(.*)~', array( 'version', 'model' ) )
+	 * it will return array( 'version' => '4.8', 'model' => 'events' )
+	 *
+	 * @param string $route
+	 * @param string $regex
+	 * @param array  $match_keys EXCLUDING matching the entire regex
+	 * @return array where  $match_keys are the keys (the first value of $match_keys
+	 *                           becomes the first key of the return value, etc. Eg passing in $match_keys of
+	 *                           array( 'model', 'id' ), will, if the regex is successful, will return
+	 *                           array( 'model' => 'foo', 'id' => 'bar' )
+	 * @throws EE_Error if it couldn't be parsed
+	 */
+	public function parseRoute(string $route, string $regex, array $match_keys): array
+	{
+		$indexed_matches = [];
+		$success         = preg_match($regex, $route, $matches);
+		if (is_array($matches)) {
+			// skip the overall regex match. Who cares
+			for ($i = 1; $i <= count($match_keys); $i++) {
+				if (! isset($matches[ $i ])) {
+					$success = false;
+				} else {
+					$indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+				}
+			}
+		}
+		if (! $success) {
+			throw new EE_Error(
+				esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
+				'endpoint_parsing_error'
+			);
+		}
+		return $indexed_matches;
+	}
+
+
+	/**
+	 * Gets the body's params (either from JSON or parsed body), which EXCLUDES the GET params and URL params
+	 *
+	 * @param WP_REST_Request $request
+	 * @return array
+	 */
+	protected function getBodyParams(WP_REST_Request $request): array
+	{
+		// $request->get_params();
+		return array_merge(
+			(array) $request->get_body_params(),
+			(array) $request->get_json_params()
+		);
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -97,7 +97,7 @@ 
      */
     protected function setDebugInfo(string $key, $info)
     {
-        $this->debug_info[ $key ] = $info;
+        $this->debug_info[$key] = $info;
     }
 
 
@@ -114,12 +114,12 @@ 
     {
         if (is_array($value)) {
             foreach ($value as $value_key => $value_value) {
-                $this->setResponseHeader($header_key . '[' . $value_key . ']', $value_value);
+                $this->setResponseHeader($header_key.'['.$value_key.']', $value_value);
             }
         } else {
             $prefix                                          =
                 $use_ee_prefix ? Base::HEADER_PREFIX_FOR_EE : Base::HEADER_PREFIX_FOR_WP;
-            $this->response_headers[ $prefix . $header_key ] = $value;
+            $this->response_headers[$prefix.$header_key] = $value;
         }
     }
 
@@ -149,7 +149,7 @@ 
     protected function addEeErrorsToResponse(WP_Error $wp_error_response): WP_Error
     {
         $notices_during_checkin = EE_Error::get_raw_notices();
-        if (! empty($notices_during_checkin['errors'])) {
+        if ( ! empty($notices_during_checkin['errors'])) {
             foreach ($notices_during_checkin['errors'] as $error_code => $error_message) {
                 $wp_error_response->add(
                     sanitize_key($error_code),
@@ -192,7 +192,7 @@ 
                 if (is_array($debug_info)) {
                     $debug_info = wp_json_encode($debug_info);
                 }
-                $headers[ 'X-EE4-Debug-' . ucwords($debug_key) ] = $debug_info;
+                $headers['X-EE4-Debug-'.ucwords($debug_key)] = $debug_info;
             }
         }
         $headers = array_merge(
@@ -251,15 +251,15 @@ 
         $headers = [];
         $notices = EE_Error::get_raw_notices();
         foreach ($notices as $notice_type => $sub_notices) {
-            if (! is_array($sub_notices)) {
+            if ( ! is_array($sub_notices)) {
                 continue;
             }
             foreach ($sub_notices as $notice_code => $sub_notice) {
-                $headers[ 'X-EE4-Notices-'
+                $headers['X-EE4-Notices-'
                           . EEH_Inflector::humanize($notice_type)
                           . '['
                           . $notice_code
-                          . ']' ] = strip_tags((string) $sub_notice);
+                          . ']'] = strip_tags((string) $sub_notice);
             }
         }
         return apply_filters(
@@ -289,7 +289,7 @@ 
         }
         $matches = $this->parseRoute(
             $route,
-            '~' . EED_Core_Rest_Api::ee_api_namespace_for_regex . '~',
+            '~'.EED_Core_Rest_Api::ee_api_namespace_for_regex.'~',
             ['version']
         );
         return $matches['version'] ?? EED_Core_Rest_Api::latest_rest_api_version();
@@ -319,14 +319,14 @@ 
         if (is_array($matches)) {
             // skip the overall regex match. Who cares
             for ($i = 1; $i <= count($match_keys); $i++) {
-                if (! isset($matches[ $i ])) {
+                if ( ! isset($matches[$i])) {
                     $success = false;
                 } else {
-                    $indexed_matches[ $match_keys[ $i - 1 ] ] = $matches[ $i ];
+                    $indexed_matches[$match_keys[$i - 1]] = $matches[$i];
                 }
             }
         }
-        if (! $success) {
+        if ( ! $success) {
             throw new EE_Error(
                 esc_html__('We could not parse the URL. Please contact Event Espresso Support', 'event_espresso'),
                 'endpoint_parsing_error'

core/libraries/rest_api/Capabilities.php

Indentation +186 added lines, -186 removed lines

@@ -16,200 +16,200 @@
  */
 class Capabilities
 {
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     * @throws EE_Error
-     */
-    public static function currentUserHasPartialAccessTo(
-        EEM_Base $model,
-        string $model_context = EEM_Base::caps_read
-    ): bool {
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $restriction_obj) {
-            if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public static function currentUserHasPartialAccessTo(
+		EEM_Base $model,
+		string $model_context = EEM_Base::caps_read
+	): bool {
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $restriction_obj) {
+			if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $request_type one of the constants on WP_JSON_Server
-     * @return array
-     * @throws EE_Error
-     */
-    public static function getMissingPermissions(EEM_Base $model, string $request_type = EEM_Base::caps_read): array
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function getMissingPermissions(EEM_Base $model, string $request_type = EEM_Base::caps_read): array
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     * @throws EE_Error
-     */
-    public static function getMissingPermissionsString(
-        EEM_Base $model,
-        string $model_context = EEM_Base::caps_read
-    ): string {
-        return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function getMissingPermissionsString(
+		EEM_Base $model,
+		string $model_context = EEM_Base::caps_read
+	): string {
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
 
-    /**
-     * "Removes" password-protected fields. Currently that means setting their values to their default.
-     *
-     * @param array            $entity
-     * @param EEM_Base         $model
-     * @param ModelVersionInfo $model_version_info
-     * @return array
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    public static function filterOutPasswordProtectedFields(
-        array $entity,
-        EEM_Base $model,
-        ModelVersionInfo $model_version_info
-    ): array {
-        $has_password = $model->hasPassword();
-        if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
-                $model->getPasswordField(),
-                $model->getPasswordField()->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $has_password
-                && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
-            ) {
-                $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $model_version_info->requestedVersion()
-                );
-                if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
-                } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw']    = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
-                        $field_obj,
-                        $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
-                        $model_version_info->requestedVersion()
-                    );
-                } else {
-                    // this is most likely an excerpt field. (These should have also had "rendered" and "raw"
-                    // versions, but we missed that, and can't change it without breaking backward compatibility)
-                    // so just remove it (or rather, set its default)
-                    // API clients will just need to look to fields with rendered formats to know if these have
-                    // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
-                }
-            }
-        }
-        return $entity;
-    }
+	/**
+	 * "Removes" password-protected fields. Currently that means setting their values to their default.
+	 *
+	 * @param array            $entity
+	 * @param EEM_Base         $model
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	public static function filterOutPasswordProtectedFields(
+		array $entity,
+		EEM_Base $model,
+		ModelVersionInfo $model_version_info
+	): array {
+		$has_password = $model->hasPassword();
+		if ($has_password) {
+			$entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+				$model->getPasswordField(),
+				$model->getPasswordField()->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$has_password
+				&& $model->getPasswordField()->fieldIsProtected($field_name)
+				&& $entity[ $field_name ]
+			) {
+				$replacement_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$model_version_info->requestedVersion()
+				);
+				if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
+					$entity[ $field_name ]['rendered'] = $replacement_value;
+				} elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
+					$entity[ $field_name ]['raw']    = $replacement_value;
+					$entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+						$field_obj,
+						$field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
+						$model_version_info->requestedVersion()
+					);
+				} else {
+					// this is most likely an excerpt field. (These should have also had "rendered" and "raw"
+					// versions, but we missed that, and can't change it without breaking backward compatibility)
+					// so just remove it (or rather, set its default)
+					// API clients will just need to look to fields with rendered formats to know if these have
+					// been redacted. Sorry.
+					$entity[ $field_name ] = $replacement_value;
+				}
+			}
+		}
+		return $entity;
+	}
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array            $entity
-     * @param EEM_Base         $model
-     * @param string           $request_type one of the return values from EEM_Base::valid_cap_contexts()
-     * @param ModelVersionInfo $model_version_info
-     * @return array ready for converting into json
-     */
-    public static function filterOutInaccessibleEntityFields(
-        array $entity,
-        EEM_Base $model,
-        string $request_type,
-        ModelVersionInfo $model_version_info
-    ): array {
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
-            ) {
-                unset($entity[ $field_name ]['raw']);
-            }
-        }
-        // theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array            $entity
+	 * @param EEM_Base         $model
+	 * @param string           $request_type one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array ready for converting into json
+	 */
+	public static function filterOutInaccessibleEntityFields(
+		array $entity,
+		EEM_Base $model,
+		string $request_type,
+		ModelVersionInfo $model_version_info
+	): array {
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$model_version_info->fieldHasRenderedFormat($field_obj)
+				&& isset($entity[ $field_name ])
+				&& is_array($entity[ $field_name ])
+				&& isset($entity[ $field_name ]['raw'])
+			) {
+				unset($entity[ $field_name ]['raw']);
+			}
+		}
+		// theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 
 
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function verifyAtLeastPartialAccessTo(
-        EEM_Base $model,
-        string $model_action_context,
-        string $action_name = 'list'
-    ) {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                ['status' => 403]
-            );
-        }
-    }
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function verifyAtLeastPartialAccessTo(
+		EEM_Base $model,
+		string $model_action_context,
+		string $action_name = 'list'
+	) {
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				['status' => 403]
+			);
+		}
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -106,7 +106,7 @@ 
     ): array {
         $has_password = $model->hasPassword();
         if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+            $entity[$model->getPasswordField()->get_name()] = ModelDataTranslator::prepareFieldValueForJson(
                 $model->getPasswordField(),
                 $model->getPasswordField()->get_default_value(),
                 $model_version_info->requestedVersion()
@@ -116,7 +116,7 @@ 
             if (
                 $has_password
                 && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
+                && $entity[$field_name]
             ) {
                 $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
@@ -124,10 +124,10 @@ 
                     $model_version_info->requestedVersion()
                 );
                 if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
+                    $entity[$field_name]['rendered'] = $replacement_value;
                 } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw']    = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+                    $entity[$field_name]['raw']    = $replacement_value;
+                    $entity[$field_name]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
                         $field_obj,
                         $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
                         $model_version_info->requestedVersion()
@@ -138,7 +138,7 @@ 
                     // so just remove it (or rather, set its default)
                     // API clients will just need to look to fields with rendered formats to know if these have
                     // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
+                    $entity[$field_name] = $replacement_value;
                 }
             }
         }
@@ -164,11 +164,11 @@ 
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (
                 $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
+                && isset($entity[$field_name])
+                && is_array($entity[$field_name])
+                && isset($entity[$field_name]['raw'])
             ) {
-                unset($entity[ $field_name ]['raw']);
+                unset($entity[$field_name]['raw']);
             }
         }
         // theoretically we may want to filter out specific fields for specific models
@@ -198,7 +198,7 @@ 
         string $model_action_context,
         string $action_name = 'list'
     ) {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

core/libraries/rest_api/RestIncomingQueryParamContext.php

Indentation +55 added lines, -55 removed lines

@@ -18,71 +18,71 @@
  */
 class RestIncomingQueryParamContext
 {
-    /**
-     * @var EEM_Base
-     */
-    private $model;
+	/**
+	 * @var EEM_Base
+	 */
+	private $model;
 
-    /**
-     * @var string
-     */
-    private $requested_version;
+	/**
+	 * @var string
+	 */
+	private $requested_version;
 
-    /**
-     * @var boolean
-     */
-    private $writing;
+	/**
+	 * @var boolean
+	 */
+	private $writing;
 
 
-    /**
-     * RestIncomingQueryParamContext constructor.
-     *
-     * @param EEM_Base        $model
-     * @param string          $requested_version
-     * @param bool|int|string $writing
-     */
-    public function __construct(EEM_Base $model, string $requested_version, $writing)
-    {
-        $this->model             = $model;
-        $this->requested_version = $requested_version;
-        $this->writing           = filter_var($writing, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * RestIncomingQueryParamContext constructor.
+	 *
+	 * @param EEM_Base        $model
+	 * @param string          $requested_version
+	 * @param bool|int|string $writing
+	 */
+	public function __construct(EEM_Base $model, string $requested_version, $writing)
+	{
+		$this->model             = $model;
+		$this->requested_version = $requested_version;
+		$this->writing           = filter_var($writing, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * Gets the model currently being requested, eg class EEM_Event
-     *
-     * @return EEM_Base
-     * @since 4.9.72.p
-     */
-    public function getModel(): EEM_Base
-    {
-        return $this->model;
-    }
+	/**
+	 * Gets the model currently being requested, eg class EEM_Event
+	 *
+	 * @return EEM_Base
+	 * @since 4.9.72.p
+	 */
+	public function getModel(): EEM_Base
+	{
+		return $this->model;
+	}
 
 
-    /**
-     * Gets the version being requested, eg 4.8.36
-     *
-     * @return string
-     * @since 4.9.72.p
-     */
-    public function getRequestedVersion(): string
-    {
-        return $this->requested_version;
-    }
+	/**
+	 * Gets the version being requested, eg 4.8.36
+	 *
+	 * @return string
+	 * @since 4.9.72.p
+	 */
+	public function getRequestedVersion(): string
+	{
+		return $this->requested_version;
+	}
 
 
-    /**
-     * Gets if the current request is for a writing request or just simple read
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    public function isWriting(): bool
-    {
-        return $this->writing;
-    }
+	/**
+	 * Gets if the current request is for a writing request or just simple read
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	public function isWriting(): bool
+	{
+		return $this->writing;
+	}
 }
 // End of file RestIncomingQueryParamContext.php
 // Location: EventEspresso\core\libraries\rest_api/RestIncomingQueryParamContext.php

core/EE_System.core.php

Indentation +1362 added lines, -1362 removed lines

@@ -26,1366 +26,1366 @@
  */
 final class EE_System implements ResettableInterface
 {
-    /**
-     * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
-     * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
-     */
-    const req_type_normal = 0;
-
-    /**
-     * Indicates this is a brand new installation of EE so we should install
-     * tables and default data etc
-     */
-    const req_type_new_activation = 1;
-
-    /**
-     * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
-     * and we just exited maintenance mode). We MUST check the database is setup properly
-     * and that default data is setup too
-     */
-    const req_type_reactivation = 2;
-
-    /**
-     * indicates that EE has been upgraded since its previous request.
-     * We may have data migration scripts to call and will want to trigger maintenance mode
-     */
-    const req_type_upgrade = 3;
-
-    /**
-     * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
-     */
-    const req_type_downgrade = 4;
-
-    /**
-     * @deprecated since version 4.6.0.dev.006
-     * Now whenever a new_activation is detected the request type is still just
-     * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
-     * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
-     * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
-     * (Specifically, when the migration manager indicates migrations are finished
-     * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
-     */
-    const req_type_activation_but_not_installed = 5;
-
-    /**
-     * option prefix for recording the activation history (like core's "espresso_db_update") of addons
-     */
-    const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
-
-    /**
-     * @var EE_System $_instance
-     */
-    private static $_instance;
-
-    /**
-     * @var EE_Registry $registry
-     */
-    private $registry;
-
-    /**
-     * @var LoaderInterface $loader
-     */
-    private $loader;
-
-    /**
-     * @var EE_Capabilities $capabilities
-     */
-    private $capabilities;
-
-    /**
-     * @var RequestInterface $request
-     */
-    private $request;
-
-    /**
-     * @var EE_Maintenance_Mode $maintenance_mode
-     */
-    private $maintenance_mode;
-
-    /**
-     * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
-     * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
-     *
-     * @var int $_req_type
-     */
-    private $_req_type;
-
-    /**
-     * Whether or not there was a non-micro version change in EE core version during this request
-     *
-     * @var boolean $_major_version_change
-     */
-    private $_major_version_change = false;
-
-    /**
-     * A Context DTO dedicated solely to identifying the current request type.
-     *
-     * @var RequestTypeContextCheckerInterface $request_type
-     */
-    private $request_type;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
-     */
-    private $register_custom_post_types;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
-     */
-    private $register_custom_taxonomies;
-
-    /**
-     * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
-     */
-    private $register_custom_taxonomy_terms;
-
-    /**
-     * @singleton method used to instantiate class object
-     * @param EE_Registry|null         $registry
-     * @param LoaderInterface|null     $loader
-     * @param RequestInterface|null    $request
-     * @param EE_Maintenance_Mode|null $maintenance_mode
-     * @return EE_System
-     */
-    public static function instance(
-        EE_Registry $registry = null,
-        LoaderInterface $loader = null,
-        RequestInterface $request = null,
-        EE_Maintenance_Mode $maintenance_mode = null
-    ) {
-        // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
-            self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
-        }
-        return self::$_instance;
-    }
-
-
-    /**
-     * resets the instance and returns it
-     *
-     * @return EE_System
-     */
-    public static function reset()
-    {
-        self::$_instance->_req_type = null;
-        // make sure none of the old hooks are left hanging around
-        remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-        // we need to reset the migration manager in order for it to detect DMSs properly
-        EE_Data_Migration_Manager::reset();
-        self::instance()->detect_activations_or_upgrades();
-        self::instance()->perform_activations_upgrades_and_migrations();
-        return self::instance();
-    }
-
-
-    /**
-     * sets hooks for running rest of system
-     * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
-     * starting EE Addons from any other point may lead to problems
-     *
-     * @param EE_Registry         $registry
-     * @param LoaderInterface     $loader
-     * @param RequestInterface    $request
-     * @param EE_Maintenance_Mode $maintenance_mode
-     */
-    private function __construct(
-        EE_Registry $registry,
-        LoaderInterface $loader,
-        RequestInterface $request,
-        EE_Maintenance_Mode $maintenance_mode
-    ) {
-        $this->registry = $registry;
-        $this->loader = $loader;
-        $this->request = $request;
-        $this->maintenance_mode = $maintenance_mode;
-        do_action('AHEE__EE_System__construct__begin', $this);
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCapabilities'),
-            5
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadCommandBus'),
-            7
-        );
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'loadPluginApi'),
-            9
-        );
-        // allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_espresso_addons',
-            array($this, 'load_espresso_addons')
-        );
-        // when an ee addon is activated, we want to call the core hook(s) again
-        // because the newly-activated addon didn't get a chance to run at all
-        add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
-        // detect whether install or upgrade
-        add_action(
-            'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
-            array($this, 'detect_activations_or_upgrades'),
-            3
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'load_core_configuration'),
-            5
-        );
-        // load specifications for matching routes to current request
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadRouteMatchSpecifications')
-        );
-        // load specifications for custom post types
-        add_action(
-            'AHEE__EE_Bootstrap__load_core_configuration',
-            array($this, 'loadCustomPostTypes')
-        );
-        // load EE_Config, EE_Textdomain, etc
-        add_action(
-            'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
-            array($this, 'register_shortcodes_modules_and_widgets'),
-            7
-        );
-        // you wanna get going? I wanna get going... let's get going!
-        add_action(
-            'AHEE__EE_Bootstrap__brew_espresso',
-            array($this, 'brew_espresso'),
-            9
-        );
-        // other housekeeping
-        // exclude EE critical pages from wp_list_pages
-        add_filter(
-            'wp_list_pages_excludes',
-            array($this, 'remove_pages_from_wp_list_pages'),
-            10
-        );
-        // ALL EE Addons should use the following hook point to attach their initial setup too
-        // it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
-        do_action('AHEE__EE_System__construct__complete', $this);
-    }
-
-
-    /**
-     * load and setup EE_Capabilities
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCapabilities()
-    {
-        $this->capabilities = $this->loader->getShared('EE_Capabilities');
-        add_action(
-            'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
-                LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
-            }
-        );
-    }
-
-
-    /**
-     * create and cache the CommandBus, and also add middleware
-     * The CapChecker middleware requires the use of EE_Capabilities
-     * which is why we need to load the CommandBus after Caps are set up
-     * CommandBus middleware operate FIFO - First In First Out
-     * so LocateMovedCommands will run first in order to return any new commands
-     *
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadCommandBus()
-    {
-        $this->loader->getShared(
-            'CommandBusInterface',
-            array(
-                null,
-                apply_filters(
-                    'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
-                    array(
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
-                        $this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
-                    )
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function loadPluginApi()
-    {
-        // set autoloaders for all of the classes implementing EEI_Plugin_API
-        // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
-    }
-
-
-    /**
-     * @param string $addon_name
-     * @param string $version_constant
-     * @param string $min_version_required
-     * @param string $load_callback
-     * @param string $plugin_file_constant
-     * @return void
-     */
-    private function deactivateIncompatibleAddon(
-        $addon_name,
-        $version_constant,
-        $min_version_required,
-        $load_callback,
-        $plugin_file_constant
-    ) {
-        if (! defined($version_constant)) {
-            return;
-        }
-        $addon_version = constant($version_constant);
-        if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
-            remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
-            }
-            deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
-            $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
-                        'event_espresso'
-                    ),
-                    $addon_name,
-                    $min_version_required
-                ),
-                __FILE__,
-                __FUNCTION__ . "({$addon_name})",
-                __LINE__
-            );
-            EE_Error::get_notices(false, true);
-        }
-    }
-
-
-    /**
-     * load_espresso_addons
-     * allow addons to load first so that they can set hooks for running DMS's, etc
-     * this is hooked into both:
-     *    'AHEE__EE_Bootstrap__load_core_configuration'
-     *        which runs during the WP 'plugins_loaded' action at priority 5
-     *    and the WP 'activate_plugin' hook point
-     *
-     * @access public
-     * @return void
-     */
-    public function load_espresso_addons()
-    {
-        $this->deactivateIncompatibleAddon(
-            'Wait Lists',
-            'EE_WAIT_LISTS_VERSION',
-            '1.0.0.beta.074',
-            'load_espresso_wait_lists',
-            'EE_WAIT_LISTS_PLUGIN_FILE'
-        );
-        $this->deactivateIncompatibleAddon(
-            'Automated Upcoming Event Notifications',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
-            '1.0.0.beta.091',
-            'load_espresso_automated_upcoming_event_notification',
-            'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
-        );
-        do_action('AHEE__EE_System__load_espresso_addons');
-        // if the WP API basic auth plugin isn't already loaded, load it now.
-        // We want it for mobile apps. Just include the entire plugin
-        // also, don't load the basic auth when a plugin is getting activated, because
-        // it could be the basic auth plugin, and it doesn't check if its methods are already defined
-        // and causes a fatal error
-        if (
-            ($this->request->isWordPressApi() || $this->request->isApi())
-            && $this->request->getRequestParam('activate') !== 'true'
-            && ! function_exists('json_basic_auth_handler')
-            && ! function_exists('json_basic_auth_error')
-            && ! in_array(
-                $this->request->getRequestParam('action'),
-                array('activate', 'activate-selected'),
-                true
-            )
-            && is_readable(EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php')
-        ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
-        }
-        do_action('AHEE__EE_System__load_espresso_addons__complete');
-    }
-
-
-    /**
-     * detect_activations_or_upgrades
-     * Checks for activation or upgrade of core first;
-     * then also checks if any registered addons have been activated or upgraded
-     * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
-     * which runs during the WP 'plugins_loaded' action at priority 3
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_activations_or_upgrades()
-    {
-        // first off: let's make sure to handle core
-        $this->detect_if_activation_or_upgrade();
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                // detect teh request type for that addon
-                $addon->detect_req_type();
-            }
-        }
-    }
-
-
-    /**
-     * detect_if_activation_or_upgrade
-     * Takes care of detecting whether this is a brand new install or code upgrade,
-     * and either setting up the DB or setting up maintenance mode etc.
-     *
-     * @access public
-     * @return void
-     */
-    public function detect_if_activation_or_upgrade()
-    {
-        do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
-        // check if db has been updated, or if its a brand-new installation
-        $espresso_db_update = $this->fix_espresso_db_upgrade_option();
-        $request_type = $this->detect_req_type($espresso_db_update);
-        // EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
-        switch ($request_type) {
-            case EE_System::req_type_new_activation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_reactivation:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_upgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
-                // migrations may be required now that we've upgraded
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_downgrade:
-                do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
-                // its possible migrations are no longer required
-                $this->maintenance_mode->set_maintenance_mode_if_db_old();
-                $this->_handle_core_version_change($espresso_db_update);
-                break;
-            case EE_System::req_type_normal:
-            default:
-                break;
-        }
-        do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
-    }
-
-
-    /**
-     * Updates the list of installed versions and sets hooks for
-     * initializing the database later during the request
-     *
-     * @param array $espresso_db_update
-     */
-    private function _handle_core_version_change($espresso_db_update)
-    {
-        $this->update_list_of_installed_versions($espresso_db_update);
-        // get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
-        add_action(
-            'AHEE__EE_System__perform_activations_upgrades_and_migrations',
-            array($this, 'initialize_db_if_no_migrations_required')
-        );
-    }
-
-
-    /**
-     * standardizes the wp option 'espresso_db_upgrade' which actually stores
-     * information about what versions of EE have been installed and activated,
-     * NOT necessarily the state of the database
-     *
-     * @param mixed $espresso_db_update           the value of the WordPress option.
-     *                                            If not supplied, fetches it from the options table
-     * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
-     */
-    private function fix_espresso_db_upgrade_option($espresso_db_update = null)
-    {
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
-            $espresso_db_update = get_option('espresso_db_update');
-        }
-        // check that option is an array
-        if (! is_array($espresso_db_update)) {
-            // if option is FALSE, then it never existed
-            if ($espresso_db_update === false) {
-                // make $espresso_db_update an array and save option with autoload OFF
-                $espresso_db_update = array();
-                add_option('espresso_db_update', $espresso_db_update, '', 'no');
-            } else {
-                // option is NOT FALSE but also is NOT an array, so make it an array and save it
-                $espresso_db_update = array($espresso_db_update => array());
-                update_option('espresso_db_update', $espresso_db_update);
-            }
-        } else {
-            $corrected_db_update = array();
-            // if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
-            foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
-                if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
-                    // the key is an int, and the value IS NOT an array
-                    // so it must be numerically-indexed, where values are versions installed...
-                    // fix it!
-                    $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
-                } else {
-                    // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
-                }
-            }
-            $espresso_db_update = $corrected_db_update;
-            update_option('espresso_db_update', $espresso_db_update);
-        }
-        do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
-        return $espresso_db_update;
-    }
-
-
-    /**
-     * Does the traditional work of setting up the plugin's database and adding default data.
-     * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
-     * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
-     * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
-     * so that it will be done when migrations are finished
-     *
-     * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
-     * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
-     *                                       This is a resource-intensive job
-     *                                       so we prefer to only do it when necessary
-     * @return void
-     * @throws EE_Error
-     */
-    public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
-    {
-        $request_type = $this->detect_req_type();
-        // only initialize system if we're not in maintenance mode.
-        if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
-            /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-            $rewrite_rules = $this->loader->getShared(
-                'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-            );
-            $rewrite_rules->flush();
-            if ($verify_schema) {
-                EEH_Activation::initialize_db_and_folders();
-            }
-            EEH_Activation::initialize_db_content();
-            EEH_Activation::system_initialization();
-            if ($initialize_addons_too) {
-                $this->initialize_addons();
-            }
-        } else {
-            EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
-        }
-        if (
-            $request_type === EE_System::req_type_new_activation
-            || $request_type === EE_System::req_type_reactivation
-            || (
-                $request_type === EE_System::req_type_upgrade
-                && $this->is_major_version_change()
-            )
-        ) {
-            add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
-        }
-    }
-
-
-    /**
-     * Initializes the db for all registered addons
-     *
-     * @throws EE_Error
-     */
-    public function initialize_addons()
-    {
-        // foreach registered addon, make sure its db is up-to-date too
-        foreach ($this->registry->addons as $addon) {
-            if ($addon instanceof EE_Addon) {
-                $addon->initialize_db_if_no_migrations_required();
-            }
-        }
-    }
-
-
-    /**
-     * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
-     *
-     * @param    array  $version_history
-     * @param    string $current_version_to_add version to be added to the version history
-     * @return    boolean success as to whether or not this option was changed
-     */
-    public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
-    {
-        if (! $version_history) {
-            $version_history = $this->fix_espresso_db_upgrade_option($version_history);
-        }
-        if ($current_version_to_add === null) {
-            $current_version_to_add = espresso_version();
-        }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
-        // re-save
-        return update_option('espresso_db_update', $version_history);
-    }
-
-
-    /**
-     * Detects if the current version indicated in the has existed in the list of
-     * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
-     *
-     * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
-     *                                  If not supplied, fetches it from the options table.
-     *                                  Also, caches its result so later parts of the code can also know whether
-     *                                  there's been an update or not. This way we can add the current version to
-     *                                  espresso_db_update, but still know if this is a new install or not
-     * @return int one of the constants on EE_System::req_type_
-     */
-    public function detect_req_type($espresso_db_update = null)
-    {
-        if ($this->_req_type === null) {
-            $espresso_db_update = ! empty($espresso_db_update)
-                ? $espresso_db_update
-                : $this->fix_espresso_db_upgrade_option();
-            $this->_req_type = EE_System::detect_req_type_given_activation_history(
-                $espresso_db_update,
-                'ee_espresso_activation',
-                espresso_version()
-            );
-            $this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
-            $this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
-        }
-        return $this->_req_type;
-    }
-
-
-    /**
-     * Returns whether or not there was a non-micro version change (ie, change in either
-     * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
-     * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @param $activation_history
-     * @return bool
-     */
-    private function _detect_major_version_change($activation_history)
-    {
-        $previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
-        $previous_version_parts = explode('.', $previous_version);
-        $current_version_parts = explode('.', espresso_version());
-        return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
-               && ($previous_version_parts[0] !== $current_version_parts[0]
-                   || $previous_version_parts[1] !== $current_version_parts[1]
-               );
-    }
-
-
-    /**
-     * Returns true if either the major or minor version of EE changed during this request.
-     * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
-     *
-     * @return bool
-     */
-    public function is_major_version_change()
-    {
-        return $this->_major_version_change;
-    }
-
-
-    /**
-     * Determines the request type for any ee addon, given three piece of info: the current array of activation
-     * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
-     * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
-     * just activated to (for core that will always be espresso_version())
-     *
-     * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
-     *                                                 ee plugin. for core that's 'espresso_db_update'
-     * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
-     *                                                 indicate that this plugin was just activated
-     * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
-     *                                                 espresso_version())
-     * @return int one of the constants on EE_System::req_type_*
-     */
-    public static function detect_req_type_given_activation_history(
-        $activation_history_for_addon,
-        $activation_indicator_option_name,
-        $version_to_upgrade_to
-    ) {
-        $version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
-        if ($activation_history_for_addon) {
-            // it exists, so this isn't a completely new install
-            // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
-                // it a version we haven't seen before
-                if ($version_is_higher === 1) {
-                    $req_type = EE_System::req_type_upgrade;
-                } else {
-                    $req_type = EE_System::req_type_downgrade;
-                }
-                delete_option($activation_indicator_option_name);
-            } else {
-                // its not an update. maybe a reactivation?
-                if (get_option($activation_indicator_option_name, false)) {
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before, but it's an activation. must be a reactivation
-                        $req_type = EE_System::req_type_reactivation;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                    delete_option($activation_indicator_option_name);
-                } else {
-                    // we've seen this version before and the activation indicate doesn't show it was just activated
-                    if ($version_is_higher === -1) {
-                        $req_type = EE_System::req_type_downgrade;
-                    } elseif ($version_is_higher === 0) {
-                        // we've seen this version before and it's not an activation. its normal request
-                        $req_type = EE_System::req_type_normal;
-                    } else {// $version_is_higher === 1
-                        $req_type = EE_System::req_type_upgrade;
-                    }
-                }
-            }
-        } else {
-            // brand new install
-            $req_type = EE_System::req_type_new_activation;
-            delete_option($activation_indicator_option_name);
-        }
-        return $req_type;
-    }
-
-
-    /**
-     * Detects if the $version_to_upgrade_to is higher than the most recent version in
-     * the $activation_history_for_addon
-     *
-     * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
-     *                                             sometimes containing 'unknown-date'
-     * @param string $version_to_upgrade_to        (current version)
-     * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
-     *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
-     *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
-     *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
-     */
-    private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
-    {
-        // find the most recently-activated version
-        $most_recently_active_version =
-            EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
-        return version_compare($version_to_upgrade_to, $most_recently_active_version);
-    }
-
-
-    /**
-     * Gets the most recently active version listed in the activation history,
-     * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
-     *
-     * @param array $activation_history  (keys are versions, values are arrays of times activated,
-     *                                   sometimes containing 'unknown-date'
-     * @return string
-     */
-    private static function _get_most_recently_active_version_from_activation_history($activation_history)
-    {
-        $most_recently_active_version_activation = '1970-01-01 00:00:00';
-        $most_recently_active_version = '0.0.0.dev.000';
-        if (is_array($activation_history)) {
-            foreach ($activation_history as $version => $times_activated) {
-                // check there is a record of when this version was activated. Otherwise,
-                // mark it as unknown
-                if (! $times_activated) {
-                    $times_activated = array('unknown-date');
-                }
-                if (is_string($times_activated)) {
-                    $times_activated = array($times_activated);
-                }
-                foreach ($times_activated as $an_activation) {
-                    if (
-                        $an_activation !== 'unknown-date'
-                        && $an_activation
-                           > $most_recently_active_version_activation
-                    ) {
-                        $most_recently_active_version = $version;
-                        $most_recently_active_version_activation = $an_activation === 'unknown-date'
-                            ? '1970-01-01 00:00:00'
-                            : $an_activation;
-                    }
-                }
-            }
-        }
-        return $most_recently_active_version;
-    }
-
-
-    /**
-     * This redirects to the about EE page after activation
-     *
-     * @return void
-     */
-    public function redirect_to_about_ee()
-    {
-        $notices = EE_Error::get_notices(false);
-        // if current user is an admin and it's not an ajax or rest request
-        if (
-            ! isset($notices['errors'])
-            && $this->request->isAdmin()
-            && apply_filters(
-                'FHEE__EE_System__redirect_to_about_ee__do_redirect',
-                $this->capabilities->current_user_can('manage_options', 'espresso_about_default')
-            )
-        ) {
-            $query_params = array('page' => 'espresso_about');
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
-                $query_params['new_activation'] = true;
-            }
-            if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
-                $query_params['reactivation'] = true;
-            }
-            $url = add_query_arg($query_params, admin_url('admin.php'));
-            wp_safe_redirect($url);
-            exit();
-        }
-    }
-
-
-    /**
-     * load_core_configuration
-     * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
-     * which runs during the WP 'plugins_loaded' action at priority 5
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function load_core_configuration()
-    {
-        do_action('AHEE__EE_System__load_core_configuration__begin', $this);
-        $this->loader->getShared('EE_Load_Textdomain');
-        // load textdomain
-        EE_Load_Textdomain::load_textdomain();
-        // load caf stuff a chance to play during the activation process too.
-        $this->_maybe_brew_regular();
-        // load and setup EE_Config and EE_Network_Config
-        $config = $this->loader->getShared('EE_Config');
-        $this->loader->getShared('EE_Network_Config');
-        // setup autoloaders
-        // enable logging?
-        $this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
-        if ($config->admin->use_remote_logging) {
-            $this->loader->getShared('EE_Log');
-        }
-        // check for activation errors
-        $activation_errors = get_option('ee_plugin_activation_errors', false);
-        if ($activation_errors) {
-            EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
-            update_option('ee_plugin_activation_errors', false);
-        }
-        // get model names
-        $this->_parse_model_names();
-        // configure custom post type definitions
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
-        $this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
-        do_action('AHEE__EE_System__load_core_configuration__complete', $this);
-    }
-
-
-    /**
-     * cycles through all of the models/*.model.php files, and assembles an array of model names
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _parse_model_names()
-    {
-        // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
-        $model_names = array();
-        $non_abstract_db_models = array();
-        foreach ($models as $model) {
-            // get model classname
-            $classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
-            $short_name = str_replace('EEM_', '', $classname);
-            $reflectionClass = new ReflectionClass($classname);
-            if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
-            }
-            $model_names[ $short_name ] = $classname;
-        }
-        $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
-        $this->registry->non_abstract_db_models = apply_filters(
-            'FHEE__EE_System__parse_implemented_model_names',
-            $non_abstract_db_models
-        );
-    }
-
-
-    /**
-     * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
-     * that need to be setup before our EE_System launches.
-     *
-     * @return void
-     * @throws DomainException
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidClassException
-     * @throws InvalidFilePathException
-     */
-    private function _maybe_brew_regular()
-    {
-        /** @var Domain $domain */
-        $domain = DomainFactory::getShared(
-            new FullyQualifiedName(
-                'EventEspresso\core\domain\Domain'
-            ),
-            array(
-                new FilePath(EVENT_ESPRESSO_MAIN_FILE),
-                Version::fromString(espresso_version()),
-            )
-        );
-        if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
-        }
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @throws Exception
-     */
-    public function loadRouteMatchSpecifications()
-    {
-        try {
-            $this->loader->getShared(
-                'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
-            );
-        } catch (Exception $exception) {
-            new ExceptionStackTraceDisplay($exception);
-        }
-        do_action('AHEE__EE_System__loadRouteMatchSpecifications');
-    }
-
-
-    /**
-     * loading CPT related classes earlier so that their definitions are available
-     * but not performing any actual registration with WP core until load_CPTs_and_session() is called
-     *
-     * @since   4.10.21.p
-     */
-    public function loadCustomPostTypes()
-    {
-        $this->register_custom_taxonomies = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
-        );
-        $this->register_custom_post_types = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
-        );
-        $this->register_custom_taxonomy_terms = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
-        );
-        // integrate WP_Query with the EE models
-        $this->loader->getShared('EE_CPT_Strategy');
-        // load legacy EE_Request_Handler in case add-ons still need it
-        $this->loader->getShared('EE_Request_Handler');
-    }
-
-
-    /**
-     * register_shortcodes_modules_and_widgets
-     * generate lists of shortcodes and modules, then verify paths and classes
-     * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
-     * which runs during the WP 'plugins_loaded' action at priority 7
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function register_shortcodes_modules_and_widgets()
-    {
-        if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
-            // load, register, and add shortcodes the new way
-            $this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
-        }
-        do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
-        // check for addons using old hook point
-        if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
-            $this->_incompatible_addon_error();
-        }
-    }
-
-
-    /**
-     * _incompatible_addon_error
-     *
-     * @access public
-     * @return void
-     */
-    private function _incompatible_addon_error()
-    {
-        // get array of classes hooking into here
-        $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
-            'AHEE__EE_System__register_shortcodes_modules_and_addons'
-        );
-        if (! empty($class_names)) {
-            $msg = esc_html__(
-                'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
-                'event_espresso'
-            );
-            $msg .= '<ul>';
-            foreach ($class_names as $class_name) {
-                $msg .= '<li><b>Event Espresso - '
-                        . str_replace(
-                            array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
-                            '',
-                            $class_name
-                        ) . '</b></li>';
-            }
-            $msg .= '</ul>';
-            $msg .= esc_html__(
-                'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
-                'event_espresso'
-            );
-            // save list of incompatible addons to wp-options for later use
-            add_option('ee_incompatible_addons', $class_names, '', 'no');
-            if (is_admin()) {
-                EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            }
-        }
-    }
-
-
-    /**
-     * brew_espresso
-     * begins the process of setting hooks for initializing EE in the correct order
-     * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
-     * which runs during the WP 'plugins_loaded' action at priority 9
-     *
-     * @return void
-     */
-    public function brew_espresso()
-    {
-        do_action('AHEE__EE_System__brew_espresso__begin', $this);
-        // load some final core systems
-        add_action('init', array($this, 'set_hooks_for_core'), 1);
-        add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
-        add_action('init', array($this, 'load_CPTs_and_session'), 5);
-        add_action('init', array($this, 'load_controllers'), 7);
-        add_action('init', array($this, 'core_loaded_and_ready'), 9);
-        add_action('init', array($this, 'initialize'), 10);
-        add_action('init', array($this, 'initialize_last'), 100);
-        if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
-            // pew pew pew
-            $this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
-            do_action('AHEE__EE_System__brew_espresso__after_pue_init');
-        }
-        do_action('AHEE__EE_System__brew_espresso__complete', $this);
-    }
-
-
-    /**
-     *    set_hooks_for_core
-     *
-     * @access public
-     * @return    void
-     * @throws EE_Error
-     */
-    public function set_hooks_for_core()
-    {
-        $this->_deactivate_incompatible_addons();
-        do_action('AHEE__EE_System__set_hooks_for_core');
-        $this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
-        // caps need to be initialized on every request so that capability maps are set.
-        // @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
-        $this->registry->CAP->init_caps();
-    }
-
-
-    /**
-     * Using the information gathered in EE_System::_incompatible_addon_error,
-     * deactivates any addons considered incompatible with the current version of EE
-     */
-    private function _deactivate_incompatible_addons()
-    {
-        $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
-            $active_plugins = get_option('active_plugins', array());
-            foreach ($active_plugins as $active_plugin) {
-                foreach ($incompatible_addons as $incompatible_addon) {
-                    if (strpos($active_plugin, $incompatible_addon) !== false) {
-                        $this->request->unSetRequestParams(['activate'], true);
-                        espresso_deactivate_plugin($active_plugin);
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    perform_activations_upgrades_and_migrations
-     *
-     * @access public
-     * @return    void
-     */
-    public function perform_activations_upgrades_and_migrations()
-    {
-        do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
-    }
-
-
-    /**
-     * @return void
-     * @throws DomainException
-     */
-    public function load_CPTs_and_session()
-    {
-        do_action('AHEE__EE_System__load_CPTs_and_session__start');
-        $this->register_custom_taxonomies->registerCustomTaxonomies();
-        $this->register_custom_post_types->registerCustomPostTypes();
-        $this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
-        // load legacy Custom Post Types and Taxonomies
-        $this->loader->getShared('EE_Register_CPTs');
-        do_action('AHEE__EE_System__load_CPTs_and_session__complete');
-    }
-
-
-    /**
-     * load_controllers
-     * this is the best place to load any additional controllers that needs access to EE core.
-     * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
-     * time
-     *
-     * @access public
-     * @return void
-     */
-    public function load_controllers()
-    {
-        do_action('AHEE__EE_System__load_controllers__start');
-        // let's get it started
-        if (
-            ! $this->maintenance_mode->level()
-            && ($this->request->isFrontend() || $this->request->isFrontAjax())
-        ) {
-            do_action('AHEE__EE_System__load_controllers__load_front_controllers');
-            $this->loader->getShared('EE_Front_Controller');
-        } elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
-            do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
-            $this->loader->getShared('EE_Admin');
-            $this->loader->getShared(
-                'EventEspresso\core\services\activation\plugin_prompt\DownloadPluginPromptManager'
-            );
-        } elseif ($this->request->isWordPressHeartbeat()) {
-            $this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
-        }
-        do_action('AHEE__EE_System__load_controllers__complete');
-    }
-
-
-    /**
-     * core_loaded_and_ready
-     * all of the basic EE core should be loaded at this point and available regardless of M-Mode
-     *
-     * @access public
-     * @return void
-     * @throws Exception
-     */
-    public function core_loaded_and_ready()
-    {
-        if (
-            $this->request->isAdmin()
-            || $this->request->isFrontend()
-            || $this->request->isIframe()
-            || $this->request->isWordPressApi()
-        ) {
-            try {
-                $this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
-                $this->loader->getShared('EventEspresso\core\services\assets\Registry');
-                $this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
-                if ($this->canLoadBlocks()) {
-                    $this->loader->getShared(
-                        'EventEspresso\core\services\editor\BlockRegistrationManager'
-                    );
-                }
-            } catch (Exception $exception) {
-                new ExceptionStackTraceDisplay($exception);
-            }
-        }
-        if (
-            $this->request->isAdmin()
-            || $this->request->isEeAjax()
-            || $this->request->isFrontend()
-        ) {
-            $this->loader->getShared('EE_Session');
-        }
-        do_action('AHEE__EE_System__core_loaded_and_ready');
-        // always load template tags, because it's faster than checking if it's a front-end request, and many page
-        // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
-        do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
-    }
-
-
-    /**
-     * initialize
-     * this is the best place to begin initializing client code
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize()
-    {
-        do_action('AHEE__EE_System__initialize');
-        add_filter(
-            'safe_style_css',
-            function ($styles) {
-                $styles[] = 'display';
-                $styles[] = 'visibility';
-                $styles[] = 'position';
-                $styles[] = 'top';
-                $styles[] = 'right';
-                $styles[] = 'bottom';
-                $styles[] = 'left';
-                $styles[] = 'resize';
-                $styles[] = 'max-width';
-                $styles[] = 'max-height';
-                return $styles;
-            }
-        );
-    }
-
-
-    /**
-     * initialize_last
-     * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
-     * initialize has done so
-     *
-     * @access public
-     * @return void
-     */
-    public function initialize_last()
-    {
-        do_action('AHEE__EE_System__initialize_last');
-        /** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
-        $rewrite_rules = $this->loader->getShared(
-            'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
-        );
-        $rewrite_rules->flushRewriteRules();
-        add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
-        if (
-            ($this->request->isAjax() || $this->request->isAdmin())
-            && $this->maintenance_mode->models_can_query()
-        ) {
-            $this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
-            $this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
-        }
-    }
-
-
-    /**
-     * @return void
-     * @throws EE_Error
-     */
-    public function addEspressoToolbar()
-    {
-        $this->loader->getShared(
-            'EventEspresso\core\domain\services\admin\AdminToolBar',
-            array($this->registry->CAP)
-        );
-    }
-
-
-    /**
-     * do_not_cache
-     * sets no cache headers and defines no cache constants for WP plugins
-     *
-     * @access public
-     * @return void
-     */
-    public static function do_not_cache()
-    {
-        // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
-            define('DONOTCACHEPAGE', true);
-        }
-        if (! defined('DONOTCACHCEOBJECT')) {
-            define('DONOTCACHCEOBJECT', true);
-        }
-        if (! defined('DONOTCACHEDB')) {
-            define('DONOTCACHEDB', true);
-        }
-        // add no cache headers
-        add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
-        // plus a little extra for nginx and Google Chrome
-        add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
-        // prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
-        remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
-    }
-
-
-    /**
-     *    extra_nocache_headers
-     *
-     * @access    public
-     * @param $headers
-     * @return    array
-     */
-    public static function extra_nocache_headers($headers)
-    {
-        // for NGINX
-        $headers['X-Accel-Expires'] = 0;
-        // plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
-        $headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
-        return $headers;
-    }
-
-
-    /**
-     *    nocache_headers
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function nocache_headers()
-    {
-        nocache_headers();
-    }
-
-
-    /**
-     * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
-     * never returned with the function.
-     *
-     * @param  array $exclude_array any existing pages being excluded are in this array.
-     * @return array
-     */
-    public function remove_pages_from_wp_list_pages($exclude_array)
-    {
-        return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
-    }
-
-
-    /**
-     * Return whether blocks can be registered/loaded or not.
-     * @return bool
-     */
-    private function canLoadBlocks()
-    {
-        return apply_filters('FHEE__EE_System__canLoadBlocks', true)
-               && function_exists('register_block_type')
-               // don't load blocks if in the Divi page builder editor context
-               // @see https://github.com/eventespresso/event-espresso-core/issues/814
-               && ! $this->request->getRequestParam('et_fb', false);
-    }
+	/**
+	 * indicates this is a 'normal' request. Ie, not activation, nor upgrade, nor activation.
+	 * So examples of this would be a normal GET request on the frontend or backend, or a POST, etc
+	 */
+	const req_type_normal = 0;
+
+	/**
+	 * Indicates this is a brand new installation of EE so we should install
+	 * tables and default data etc
+	 */
+	const req_type_new_activation = 1;
+
+	/**
+	 * we've detected that EE has been reactivated (or EE was activated during maintenance mode,
+	 * and we just exited maintenance mode). We MUST check the database is setup properly
+	 * and that default data is setup too
+	 */
+	const req_type_reactivation = 2;
+
+	/**
+	 * indicates that EE has been upgraded since its previous request.
+	 * We may have data migration scripts to call and will want to trigger maintenance mode
+	 */
+	const req_type_upgrade = 3;
+
+	/**
+	 * TODO  will detect that EE has been DOWNGRADED. We probably don't want to run in this case...
+	 */
+	const req_type_downgrade = 4;
+
+	/**
+	 * @deprecated since version 4.6.0.dev.006
+	 * Now whenever a new_activation is detected the request type is still just
+	 * new_activation (same for reactivation, upgrade, downgrade etc), but if we'r ein maintenance mode
+	 * EE_System::initialize_db_if_no_migrations_required and EE_Addon::initialize_db_if_no_migrations_required
+	 * will instead enqueue that EE plugin's db initialization for when we're taken out of maintenance mode.
+	 * (Specifically, when the migration manager indicates migrations are finished
+	 * EE_Data_Migration_Manager::initialize_db_for_enqueued_ee_plugins() will be called)
+	 */
+	const req_type_activation_but_not_installed = 5;
+
+	/**
+	 * option prefix for recording the activation history (like core's "espresso_db_update") of addons
+	 */
+	const addon_activation_history_option_prefix = 'ee_addon_activation_history_';
+
+	/**
+	 * @var EE_System $_instance
+	 */
+	private static $_instance;
+
+	/**
+	 * @var EE_Registry $registry
+	 */
+	private $registry;
+
+	/**
+	 * @var LoaderInterface $loader
+	 */
+	private $loader;
+
+	/**
+	 * @var EE_Capabilities $capabilities
+	 */
+	private $capabilities;
+
+	/**
+	 * @var RequestInterface $request
+	 */
+	private $request;
+
+	/**
+	 * @var EE_Maintenance_Mode $maintenance_mode
+	 */
+	private $maintenance_mode;
+
+	/**
+	 * Stores which type of request this is, options being one of the constants on EE_System starting with req_type_*.
+	 * It can be a brand-new activation, a reactivation, an upgrade, a downgrade, or a normal request.
+	 *
+	 * @var int $_req_type
+	 */
+	private $_req_type;
+
+	/**
+	 * Whether or not there was a non-micro version change in EE core version during this request
+	 *
+	 * @var boolean $_major_version_change
+	 */
+	private $_major_version_change = false;
+
+	/**
+	 * A Context DTO dedicated solely to identifying the current request type.
+	 *
+	 * @var RequestTypeContextCheckerInterface $request_type
+	 */
+	private $request_type;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes
+	 */
+	private $register_custom_post_types;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies
+	 */
+	private $register_custom_taxonomies;
+
+	/**
+	 * @param EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms
+	 */
+	private $register_custom_taxonomy_terms;
+
+	/**
+	 * @singleton method used to instantiate class object
+	 * @param EE_Registry|null         $registry
+	 * @param LoaderInterface|null     $loader
+	 * @param RequestInterface|null    $request
+	 * @param EE_Maintenance_Mode|null $maintenance_mode
+	 * @return EE_System
+	 */
+	public static function instance(
+		EE_Registry $registry = null,
+		LoaderInterface $loader = null,
+		RequestInterface $request = null,
+		EE_Maintenance_Mode $maintenance_mode = null
+	) {
+		// check if class object is instantiated
+		if (! self::$_instance instanceof EE_System) {
+			self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
+		}
+		return self::$_instance;
+	}
+
+
+	/**
+	 * resets the instance and returns it
+	 *
+	 * @return EE_System
+	 */
+	public static function reset()
+	{
+		self::$_instance->_req_type = null;
+		// make sure none of the old hooks are left hanging around
+		remove_all_actions('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+		// we need to reset the migration manager in order for it to detect DMSs properly
+		EE_Data_Migration_Manager::reset();
+		self::instance()->detect_activations_or_upgrades();
+		self::instance()->perform_activations_upgrades_and_migrations();
+		return self::instance();
+	}
+
+
+	/**
+	 * sets hooks for running rest of system
+	 * provides "AHEE__EE_System__construct__complete" hook for EE Addons to use as their starting point
+	 * starting EE Addons from any other point may lead to problems
+	 *
+	 * @param EE_Registry         $registry
+	 * @param LoaderInterface     $loader
+	 * @param RequestInterface    $request
+	 * @param EE_Maintenance_Mode $maintenance_mode
+	 */
+	private function __construct(
+		EE_Registry $registry,
+		LoaderInterface $loader,
+		RequestInterface $request,
+		EE_Maintenance_Mode $maintenance_mode
+	) {
+		$this->registry = $registry;
+		$this->loader = $loader;
+		$this->request = $request;
+		$this->maintenance_mode = $maintenance_mode;
+		do_action('AHEE__EE_System__construct__begin', $this);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCapabilities'),
+			5
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadCommandBus'),
+			7
+		);
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'loadPluginApi'),
+			9
+		);
+		// allow addons to load first so that they can register autoloaders, set hooks for running DMS's, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_espresso_addons',
+			array($this, 'load_espresso_addons')
+		);
+		// when an ee addon is activated, we want to call the core hook(s) again
+		// because the newly-activated addon didn't get a chance to run at all
+		add_action('activate_plugin', array($this, 'load_espresso_addons'), 1);
+		// detect whether install or upgrade
+		add_action(
+			'AHEE__EE_Bootstrap__detect_activations_or_upgrades',
+			array($this, 'detect_activations_or_upgrades'),
+			3
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'load_core_configuration'),
+			5
+		);
+		// load specifications for matching routes to current request
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadRouteMatchSpecifications')
+		);
+		// load specifications for custom post types
+		add_action(
+			'AHEE__EE_Bootstrap__load_core_configuration',
+			array($this, 'loadCustomPostTypes')
+		);
+		// load EE_Config, EE_Textdomain, etc
+		add_action(
+			'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets',
+			array($this, 'register_shortcodes_modules_and_widgets'),
+			7
+		);
+		// you wanna get going? I wanna get going... let's get going!
+		add_action(
+			'AHEE__EE_Bootstrap__brew_espresso',
+			array($this, 'brew_espresso'),
+			9
+		);
+		// other housekeeping
+		// exclude EE critical pages from wp_list_pages
+		add_filter(
+			'wp_list_pages_excludes',
+			array($this, 'remove_pages_from_wp_list_pages'),
+			10
+		);
+		// ALL EE Addons should use the following hook point to attach their initial setup too
+		// it's extremely important for EE Addons to register any class autoloaders so that they can be available when the EE_Config loads
+		do_action('AHEE__EE_System__construct__complete', $this);
+	}
+
+
+	/**
+	 * load and setup EE_Capabilities
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCapabilities()
+	{
+		$this->capabilities = $this->loader->getShared('EE_Capabilities');
+		add_action(
+			'AHEE__EE_Capabilities__init_caps__before_initialization',
+			function () {
+				LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
+			}
+		);
+	}
+
+
+	/**
+	 * create and cache the CommandBus, and also add middleware
+	 * The CapChecker middleware requires the use of EE_Capabilities
+	 * which is why we need to load the CommandBus after Caps are set up
+	 * CommandBus middleware operate FIFO - First In First Out
+	 * so LocateMovedCommands will run first in order to return any new commands
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadCommandBus()
+	{
+		$this->loader->getShared(
+			'CommandBusInterface',
+			array(
+				null,
+				apply_filters(
+					'FHEE__EE_Load_Espresso_Core__handle_request__CommandBus_middleware',
+					array(
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\LocateMovedCommands'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\CapChecker'),
+						$this->loader->getShared('EventEspresso\core\services\commands\middleware\AddActionHook'),
+					)
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function loadPluginApi()
+	{
+		// set autoloaders for all of the classes implementing EEI_Plugin_API
+		// which provide helpers for EE plugin authors to more easily register certain components with EE.
+		EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+	}
+
+
+	/**
+	 * @param string $addon_name
+	 * @param string $version_constant
+	 * @param string $min_version_required
+	 * @param string $load_callback
+	 * @param string $plugin_file_constant
+	 * @return void
+	 */
+	private function deactivateIncompatibleAddon(
+		$addon_name,
+		$version_constant,
+		$min_version_required,
+		$load_callback,
+		$plugin_file_constant
+	) {
+		if (! defined($version_constant)) {
+			return;
+		}
+		$addon_version = constant($version_constant);
+		if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
+			remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
+			if (! function_exists('deactivate_plugins')) {
+				require_once ABSPATH . 'wp-admin/includes/plugin.php';
+			}
+			deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
+			$this->request->unSetRequestParams(['activate', 'activate-multi'], true);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'We\'re sorry, but the Event Espresso %1$s addon was deactivated because version %2$s or higher is required with this version of Event Espresso core.',
+						'event_espresso'
+					),
+					$addon_name,
+					$min_version_required
+				),
+				__FILE__,
+				__FUNCTION__ . "({$addon_name})",
+				__LINE__
+			);
+			EE_Error::get_notices(false, true);
+		}
+	}
+
+
+	/**
+	 * load_espresso_addons
+	 * allow addons to load first so that they can set hooks for running DMS's, etc
+	 * this is hooked into both:
+	 *    'AHEE__EE_Bootstrap__load_core_configuration'
+	 *        which runs during the WP 'plugins_loaded' action at priority 5
+	 *    and the WP 'activate_plugin' hook point
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_espresso_addons()
+	{
+		$this->deactivateIncompatibleAddon(
+			'Wait Lists',
+			'EE_WAIT_LISTS_VERSION',
+			'1.0.0.beta.074',
+			'load_espresso_wait_lists',
+			'EE_WAIT_LISTS_PLUGIN_FILE'
+		);
+		$this->deactivateIncompatibleAddon(
+			'Automated Upcoming Event Notifications',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_VERSION',
+			'1.0.0.beta.091',
+			'load_espresso_automated_upcoming_event_notification',
+			'EE_AUTOMATED_UPCOMING_EVENT_NOTIFICATION_PLUGIN_FILE'
+		);
+		do_action('AHEE__EE_System__load_espresso_addons');
+		// if the WP API basic auth plugin isn't already loaded, load it now.
+		// We want it for mobile apps. Just include the entire plugin
+		// also, don't load the basic auth when a plugin is getting activated, because
+		// it could be the basic auth plugin, and it doesn't check if its methods are already defined
+		// and causes a fatal error
+		if (
+			($this->request->isWordPressApi() || $this->request->isApi())
+			&& $this->request->getRequestParam('activate') !== 'true'
+			&& ! function_exists('json_basic_auth_handler')
+			&& ! function_exists('json_basic_auth_error')
+			&& ! in_array(
+				$this->request->getRequestParam('action'),
+				array('activate', 'activate-selected'),
+				true
+			)
+			&& is_readable(EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php')
+		) {
+			include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+		}
+		do_action('AHEE__EE_System__load_espresso_addons__complete');
+	}
+
+
+	/**
+	 * detect_activations_or_upgrades
+	 * Checks for activation or upgrade of core first;
+	 * then also checks if any registered addons have been activated or upgraded
+	 * This is hooked into 'AHEE__EE_Bootstrap__detect_activations_or_upgrades'
+	 * which runs during the WP 'plugins_loaded' action at priority 3
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_activations_or_upgrades()
+	{
+		// first off: let's make sure to handle core
+		$this->detect_if_activation_or_upgrade();
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				// detect teh request type for that addon
+				$addon->detect_req_type();
+			}
+		}
+	}
+
+
+	/**
+	 * detect_if_activation_or_upgrade
+	 * Takes care of detecting whether this is a brand new install or code upgrade,
+	 * and either setting up the DB or setting up maintenance mode etc.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function detect_if_activation_or_upgrade()
+	{
+		do_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin');
+		// check if db has been updated, or if its a brand-new installation
+		$espresso_db_update = $this->fix_espresso_db_upgrade_option();
+		$request_type = $this->detect_req_type($espresso_db_update);
+		// EEH_Debug_Tools::printr( $request_type, '$request_type', __FILE__, __LINE__ );
+		switch ($request_type) {
+			case EE_System::req_type_new_activation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__new_activation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_reactivation:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__reactivation');
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_upgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__upgrade');
+				// migrations may be required now that we've upgraded
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_downgrade:
+				do_action('AHEE__EE_System__detect_if_activation_or_upgrade__downgrade');
+				// its possible migrations are no longer required
+				$this->maintenance_mode->set_maintenance_mode_if_db_old();
+				$this->_handle_core_version_change($espresso_db_update);
+				break;
+			case EE_System::req_type_normal:
+			default:
+				break;
+		}
+		do_action('AHEE__EE_System__detect_if_activation_or_upgrade__complete');
+	}
+
+
+	/**
+	 * Updates the list of installed versions and sets hooks for
+	 * initializing the database later during the request
+	 *
+	 * @param array $espresso_db_update
+	 */
+	private function _handle_core_version_change($espresso_db_update)
+	{
+		$this->update_list_of_installed_versions($espresso_db_update);
+		// get ready to verify the DB is ok (provided we aren't in maintenance mode, of course)
+		add_action(
+			'AHEE__EE_System__perform_activations_upgrades_and_migrations',
+			array($this, 'initialize_db_if_no_migrations_required')
+		);
+	}
+
+
+	/**
+	 * standardizes the wp option 'espresso_db_upgrade' which actually stores
+	 * information about what versions of EE have been installed and activated,
+	 * NOT necessarily the state of the database
+	 *
+	 * @param mixed $espresso_db_update           the value of the WordPress option.
+	 *                                            If not supplied, fetches it from the options table
+	 * @return array the correct value of 'espresso_db_upgrade', after saving it, if it needed correction
+	 */
+	private function fix_espresso_db_upgrade_option($espresso_db_update = null)
+	{
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
+		if (! $espresso_db_update) {
+			$espresso_db_update = get_option('espresso_db_update');
+		}
+		// check that option is an array
+		if (! is_array($espresso_db_update)) {
+			// if option is FALSE, then it never existed
+			if ($espresso_db_update === false) {
+				// make $espresso_db_update an array and save option with autoload OFF
+				$espresso_db_update = array();
+				add_option('espresso_db_update', $espresso_db_update, '', 'no');
+			} else {
+				// option is NOT FALSE but also is NOT an array, so make it an array and save it
+				$espresso_db_update = array($espresso_db_update => array());
+				update_option('espresso_db_update', $espresso_db_update);
+			}
+		} else {
+			$corrected_db_update = array();
+			// if IS an array, but is it an array where KEYS are version numbers, and values are arrays?
+			foreach ($espresso_db_update as $should_be_version_string => $should_be_array) {
+				if (is_int($should_be_version_string) && ! is_array($should_be_array)) {
+					// the key is an int, and the value IS NOT an array
+					// so it must be numerically-indexed, where values are versions installed...
+					// fix it!
+					$version_string = $should_be_array;
+					$corrected_db_update[ $version_string ] = array('unknown-date');
+				} else {
+					// ok it checks out
+					$corrected_db_update[ $should_be_version_string ] = $should_be_array;
+				}
+			}
+			$espresso_db_update = $corrected_db_update;
+			update_option('espresso_db_update', $espresso_db_update);
+		}
+		do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__complete', $espresso_db_update);
+		return $espresso_db_update;
+	}
+
+
+	/**
+	 * Does the traditional work of setting up the plugin's database and adding default data.
+	 * If migration script/process did not exist, this is what would happen on every activation/reactivation/upgrade.
+	 * NOTE: if we're in maintenance mode (which would be the case if we detect there are data
+	 * migration scripts that need to be run and a version change happens), enqueues core for database initialization,
+	 * so that it will be done when migrations are finished
+	 *
+	 * @param boolean $initialize_addons_too if true, we double-check addons' database tables etc too;
+	 * @param boolean $verify_schema         if true will re-check the database tables have the correct schema.
+	 *                                       This is a resource-intensive job
+	 *                                       so we prefer to only do it when necessary
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function initialize_db_if_no_migrations_required($initialize_addons_too = false, $verify_schema = true)
+	{
+		$request_type = $this->detect_req_type();
+		// only initialize system if we're not in maintenance mode.
+		if ($this->maintenance_mode->level() !== EE_Maintenance_Mode::level_2_complete_maintenance) {
+			/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+			$rewrite_rules = $this->loader->getShared(
+				'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+			);
+			$rewrite_rules->flush();
+			if ($verify_schema) {
+				EEH_Activation::initialize_db_and_folders();
+			}
+			EEH_Activation::initialize_db_content();
+			EEH_Activation::system_initialization();
+			if ($initialize_addons_too) {
+				$this->initialize_addons();
+			}
+		} else {
+			EE_Data_Migration_Manager::instance()->enqueue_db_initialization_for('Core');
+		}
+		if (
+			$request_type === EE_System::req_type_new_activation
+			|| $request_type === EE_System::req_type_reactivation
+			|| (
+				$request_type === EE_System::req_type_upgrade
+				&& $this->is_major_version_change()
+			)
+		) {
+			add_action('AHEE__EE_System__initialize_last', array($this, 'redirect_to_about_ee'), 9);
+		}
+	}
+
+
+	/**
+	 * Initializes the db for all registered addons
+	 *
+	 * @throws EE_Error
+	 */
+	public function initialize_addons()
+	{
+		// foreach registered addon, make sure its db is up-to-date too
+		foreach ($this->registry->addons as $addon) {
+			if ($addon instanceof EE_Addon) {
+				$addon->initialize_db_if_no_migrations_required();
+			}
+		}
+	}
+
+
+	/**
+	 * Adds the current code version to the saved wp option which stores a list of all ee versions ever installed.
+	 *
+	 * @param    array  $version_history
+	 * @param    string $current_version_to_add version to be added to the version history
+	 * @return    boolean success as to whether or not this option was changed
+	 */
+	public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
+	{
+		if (! $version_history) {
+			$version_history = $this->fix_espresso_db_upgrade_option($version_history);
+		}
+		if ($current_version_to_add === null) {
+			$current_version_to_add = espresso_version();
+		}
+		$version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+		// re-save
+		return update_option('espresso_db_update', $version_history);
+	}
+
+
+	/**
+	 * Detects if the current version indicated in the has existed in the list of
+	 * previously-installed versions of EE (espresso_db_update). Does NOT modify it (ie, no side-effect)
+	 *
+	 * @param array $espresso_db_update array from the wp option stored under the name 'espresso_db_update'.
+	 *                                  If not supplied, fetches it from the options table.
+	 *                                  Also, caches its result so later parts of the code can also know whether
+	 *                                  there's been an update or not. This way we can add the current version to
+	 *                                  espresso_db_update, but still know if this is a new install or not
+	 * @return int one of the constants on EE_System::req_type_
+	 */
+	public function detect_req_type($espresso_db_update = null)
+	{
+		if ($this->_req_type === null) {
+			$espresso_db_update = ! empty($espresso_db_update)
+				? $espresso_db_update
+				: $this->fix_espresso_db_upgrade_option();
+			$this->_req_type = EE_System::detect_req_type_given_activation_history(
+				$espresso_db_update,
+				'ee_espresso_activation',
+				espresso_version()
+			);
+			$this->_major_version_change = $this->_detect_major_version_change($espresso_db_update);
+			$this->request->setIsActivation($this->_req_type !== EE_System::req_type_normal);
+		}
+		return $this->_req_type;
+	}
+
+
+	/**
+	 * Returns whether or not there was a non-micro version change (ie, change in either
+	 * the first or second number in the version. Eg 4.9.0.rc.001 to 4.10.0.rc.000,
+	 * but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @param $activation_history
+	 * @return bool
+	 */
+	private function _detect_major_version_change($activation_history)
+	{
+		$previous_version = EE_System::_get_most_recently_active_version_from_activation_history($activation_history);
+		$previous_version_parts = explode('.', $previous_version);
+		$current_version_parts = explode('.', espresso_version());
+		return isset($previous_version_parts[0], $previous_version_parts[1], $current_version_parts[0], $current_version_parts[1])
+			   && ($previous_version_parts[0] !== $current_version_parts[0]
+				   || $previous_version_parts[1] !== $current_version_parts[1]
+			   );
+	}
+
+
+	/**
+	 * Returns true if either the major or minor version of EE changed during this request.
+	 * Eg 4.9.0.rc.001 to 4.10.0.rc.000, but not 4.9.0.rc.0001 to 4.9.1.rc.0001
+	 *
+	 * @return bool
+	 */
+	public function is_major_version_change()
+	{
+		return $this->_major_version_change;
+	}
+
+
+	/**
+	 * Determines the request type for any ee addon, given three piece of info: the current array of activation
+	 * histories (for core that' 'espresso_db_update' wp option); the name of the WordPress option which is temporarily
+	 * set upon activation of the plugin (for core it's 'ee_espresso_activation'); and the version that this plugin was
+	 * just activated to (for core that will always be espresso_version())
+	 *
+	 * @param array  $activation_history_for_addon     the option's value which stores the activation history for this
+	 *                                                 ee plugin. for core that's 'espresso_db_update'
+	 * @param string $activation_indicator_option_name the name of the WordPress option that is temporarily set to
+	 *                                                 indicate that this plugin was just activated
+	 * @param string $version_to_upgrade_to            the version that was just upgraded to (for core that will be
+	 *                                                 espresso_version())
+	 * @return int one of the constants on EE_System::req_type_*
+	 */
+	public static function detect_req_type_given_activation_history(
+		$activation_history_for_addon,
+		$activation_indicator_option_name,
+		$version_to_upgrade_to
+	) {
+		$version_is_higher = self::_new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to);
+		if ($activation_history_for_addon) {
+			// it exists, so this isn't a completely new install
+			// check if this version already in that list of previously installed versions
+			if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+				// it a version we haven't seen before
+				if ($version_is_higher === 1) {
+					$req_type = EE_System::req_type_upgrade;
+				} else {
+					$req_type = EE_System::req_type_downgrade;
+				}
+				delete_option($activation_indicator_option_name);
+			} else {
+				// its not an update. maybe a reactivation?
+				if (get_option($activation_indicator_option_name, false)) {
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before, but it's an activation. must be a reactivation
+						$req_type = EE_System::req_type_reactivation;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+					delete_option($activation_indicator_option_name);
+				} else {
+					// we've seen this version before and the activation indicate doesn't show it was just activated
+					if ($version_is_higher === -1) {
+						$req_type = EE_System::req_type_downgrade;
+					} elseif ($version_is_higher === 0) {
+						// we've seen this version before and it's not an activation. its normal request
+						$req_type = EE_System::req_type_normal;
+					} else {// $version_is_higher === 1
+						$req_type = EE_System::req_type_upgrade;
+					}
+				}
+			}
+		} else {
+			// brand new install
+			$req_type = EE_System::req_type_new_activation;
+			delete_option($activation_indicator_option_name);
+		}
+		return $req_type;
+	}
+
+
+	/**
+	 * Detects if the $version_to_upgrade_to is higher than the most recent version in
+	 * the $activation_history_for_addon
+	 *
+	 * @param array  $activation_history_for_addon (keys are versions, values are arrays of times activated,
+	 *                                             sometimes containing 'unknown-date'
+	 * @param string $version_to_upgrade_to        (current version)
+	 * @return int results of version_compare( $version_to_upgrade_to, $most_recently_active_version ).
+	 *                                             ie, -1 if $version_to_upgrade_to is LOWER (downgrade);
+	 *                                             0 if $version_to_upgrade_to MATCHES (reactivation or normal request);
+	 *                                             1 if $version_to_upgrade_to is HIGHER (upgrade) ;
+	 */
+	private static function _new_version_is_higher($activation_history_for_addon, $version_to_upgrade_to)
+	{
+		// find the most recently-activated version
+		$most_recently_active_version =
+			EE_System::_get_most_recently_active_version_from_activation_history($activation_history_for_addon);
+		return version_compare($version_to_upgrade_to, $most_recently_active_version);
+	}
+
+
+	/**
+	 * Gets the most recently active version listed in the activation history,
+	 * and if none are found (ie, it's a brand new install) returns '0.0.0.dev.000'.
+	 *
+	 * @param array $activation_history  (keys are versions, values are arrays of times activated,
+	 *                                   sometimes containing 'unknown-date'
+	 * @return string
+	 */
+	private static function _get_most_recently_active_version_from_activation_history($activation_history)
+	{
+		$most_recently_active_version_activation = '1970-01-01 00:00:00';
+		$most_recently_active_version = '0.0.0.dev.000';
+		if (is_array($activation_history)) {
+			foreach ($activation_history as $version => $times_activated) {
+				// check there is a record of when this version was activated. Otherwise,
+				// mark it as unknown
+				if (! $times_activated) {
+					$times_activated = array('unknown-date');
+				}
+				if (is_string($times_activated)) {
+					$times_activated = array($times_activated);
+				}
+				foreach ($times_activated as $an_activation) {
+					if (
+						$an_activation !== 'unknown-date'
+						&& $an_activation
+						   > $most_recently_active_version_activation
+					) {
+						$most_recently_active_version = $version;
+						$most_recently_active_version_activation = $an_activation === 'unknown-date'
+							? '1970-01-01 00:00:00'
+							: $an_activation;
+					}
+				}
+			}
+		}
+		return $most_recently_active_version;
+	}
+
+
+	/**
+	 * This redirects to the about EE page after activation
+	 *
+	 * @return void
+	 */
+	public function redirect_to_about_ee()
+	{
+		$notices = EE_Error::get_notices(false);
+		// if current user is an admin and it's not an ajax or rest request
+		if (
+			! isset($notices['errors'])
+			&& $this->request->isAdmin()
+			&& apply_filters(
+				'FHEE__EE_System__redirect_to_about_ee__do_redirect',
+				$this->capabilities->current_user_can('manage_options', 'espresso_about_default')
+			)
+		) {
+			$query_params = array('page' => 'espresso_about');
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_new_activation) {
+				$query_params['new_activation'] = true;
+			}
+			if (EE_System::instance()->detect_req_type() === EE_System::req_type_reactivation) {
+				$query_params['reactivation'] = true;
+			}
+			$url = add_query_arg($query_params, admin_url('admin.php'));
+			wp_safe_redirect($url);
+			exit();
+		}
+	}
+
+
+	/**
+	 * load_core_configuration
+	 * this is hooked into 'AHEE__EE_Bootstrap__load_core_configuration'
+	 * which runs during the WP 'plugins_loaded' action at priority 5
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function load_core_configuration()
+	{
+		do_action('AHEE__EE_System__load_core_configuration__begin', $this);
+		$this->loader->getShared('EE_Load_Textdomain');
+		// load textdomain
+		EE_Load_Textdomain::load_textdomain();
+		// load caf stuff a chance to play during the activation process too.
+		$this->_maybe_brew_regular();
+		// load and setup EE_Config and EE_Network_Config
+		$config = $this->loader->getShared('EE_Config');
+		$this->loader->getShared('EE_Network_Config');
+		// setup autoloaders
+		// enable logging?
+		$this->loader->getShared('EventEspresso\core\services\orm\TrashLogger');
+		if ($config->admin->use_remote_logging) {
+			$this->loader->getShared('EE_Log');
+		}
+		// check for activation errors
+		$activation_errors = get_option('ee_plugin_activation_errors', false);
+		if ($activation_errors) {
+			EE_Error::add_error($activation_errors, __FILE__, __FUNCTION__, __LINE__);
+			update_option('ee_plugin_activation_errors', false);
+		}
+		// get model names
+		$this->_parse_model_names();
+		// configure custom post type definitions
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomTaxonomyDefinitions');
+		$this->loader->getShared('EventEspresso\core\domain\entities\custom_post_types\CustomPostTypeDefinitions');
+		do_action('AHEE__EE_System__load_core_configuration__complete', $this);
+	}
+
+
+	/**
+	 * cycles through all of the models/*.model.php files, and assembles an array of model names
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _parse_model_names()
+	{
+		// get all the files in the EE_MODELS folder that end in .model.php
+		$models = glob(EE_MODELS . '*.model.php');
+		$model_names = array();
+		$non_abstract_db_models = array();
+		foreach ($models as $model) {
+			// get model classname
+			$classname = EEH_File::get_classname_from_filepath_with_standard_filename($model);
+			$short_name = str_replace('EEM_', '', $classname);
+			$reflectionClass = new ReflectionClass($classname);
+			if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
+				$non_abstract_db_models[ $short_name ] = $classname;
+			}
+			$model_names[ $short_name ] = $classname;
+		}
+		$this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
+		$this->registry->non_abstract_db_models = apply_filters(
+			'FHEE__EE_System__parse_implemented_model_names',
+			$non_abstract_db_models
+		);
+	}
+
+
+	/**
+	 * The purpose of this method is to simply check for a file named "caffeinated/brewing_regular.php" for any hooks
+	 * that need to be setup before our EE_System launches.
+	 *
+	 * @return void
+	 * @throws DomainException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidClassException
+	 * @throws InvalidFilePathException
+	 */
+	private function _maybe_brew_regular()
+	{
+		/** @var Domain $domain */
+		$domain = DomainFactory::getShared(
+			new FullyQualifiedName(
+				'EventEspresso\core\domain\Domain'
+			),
+			array(
+				new FilePath(EVENT_ESPRESSO_MAIN_FILE),
+				Version::fromString(espresso_version()),
+			)
+		);
+		if ($domain->isCaffeinated()) {
+			require_once EE_CAFF_PATH . 'brewing_regular.php';
+		}
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @throws Exception
+	 */
+	public function loadRouteMatchSpecifications()
+	{
+		try {
+			$this->loader->getShared(
+				'EventEspresso\core\services\route_match\RouteMatchSpecificationManager'
+			);
+		} catch (Exception $exception) {
+			new ExceptionStackTraceDisplay($exception);
+		}
+		do_action('AHEE__EE_System__loadRouteMatchSpecifications');
+	}
+
+
+	/**
+	 * loading CPT related classes earlier so that their definitions are available
+	 * but not performing any actual registration with WP core until load_CPTs_and_session() is called
+	 *
+	 * @since   4.10.21.p
+	 */
+	public function loadCustomPostTypes()
+	{
+		$this->register_custom_taxonomies = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomies'
+		);
+		$this->register_custom_post_types = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomPostTypes'
+		);
+		$this->register_custom_taxonomy_terms = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RegisterCustomTaxonomyTerms'
+		);
+		// integrate WP_Query with the EE models
+		$this->loader->getShared('EE_CPT_Strategy');
+		// load legacy EE_Request_Handler in case add-ons still need it
+		$this->loader->getShared('EE_Request_Handler');
+	}
+
+
+	/**
+	 * register_shortcodes_modules_and_widgets
+	 * generate lists of shortcodes and modules, then verify paths and classes
+	 * This is hooked into 'AHEE__EE_Bootstrap__register_shortcodes_modules_and_widgets'
+	 * which runs during the WP 'plugins_loaded' action at priority 7
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function register_shortcodes_modules_and_widgets()
+	{
+		if ($this->request->isFrontend() || $this->request->isIframe() || $this->request->isAjax()) {
+			// load, register, and add shortcodes the new way
+			$this->loader->getShared('EventEspresso\core\services\shortcodes\ShortcodesManager');
+		}
+		do_action('AHEE__EE_System__register_shortcodes_modules_and_widgets');
+		// check for addons using old hook point
+		if (has_action('AHEE__EE_System__register_shortcodes_modules_and_addons')) {
+			$this->_incompatible_addon_error();
+		}
+	}
+
+
+	/**
+	 * _incompatible_addon_error
+	 *
+	 * @access public
+	 * @return void
+	 */
+	private function _incompatible_addon_error()
+	{
+		// get array of classes hooking into here
+		$class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
+			'AHEE__EE_System__register_shortcodes_modules_and_addons'
+		);
+		if (! empty($class_names)) {
+			$msg = esc_html__(
+				'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
+				'event_espresso'
+			);
+			$msg .= '<ul>';
+			foreach ($class_names as $class_name) {
+				$msg .= '<li><b>Event Espresso - '
+						. str_replace(
+							array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
+							'',
+							$class_name
+						) . '</b></li>';
+			}
+			$msg .= '</ul>';
+			$msg .= esc_html__(
+				'Compatibility issues can be avoided and/or resolved by keeping addons and plugins updated to the latest version.',
+				'event_espresso'
+			);
+			// save list of incompatible addons to wp-options for later use
+			add_option('ee_incompatible_addons', $class_names, '', 'no');
+			if (is_admin()) {
+				EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			}
+		}
+	}
+
+
+	/**
+	 * brew_espresso
+	 * begins the process of setting hooks for initializing EE in the correct order
+	 * This is happening on the 'AHEE__EE_Bootstrap__brew_espresso' hook point
+	 * which runs during the WP 'plugins_loaded' action at priority 9
+	 *
+	 * @return void
+	 */
+	public function brew_espresso()
+	{
+		do_action('AHEE__EE_System__brew_espresso__begin', $this);
+		// load some final core systems
+		add_action('init', array($this, 'set_hooks_for_core'), 1);
+		add_action('init', array($this, 'perform_activations_upgrades_and_migrations'), 3);
+		add_action('init', array($this, 'load_CPTs_and_session'), 5);
+		add_action('init', array($this, 'load_controllers'), 7);
+		add_action('init', array($this, 'core_loaded_and_ready'), 9);
+		add_action('init', array($this, 'initialize'), 10);
+		add_action('init', array($this, 'initialize_last'), 100);
+		if (is_admin() && apply_filters('FHEE__EE_System__brew_espresso__load_pue', true)) {
+			// pew pew pew
+			$this->loader->getShared('EventEspresso\core\services\licensing\LicenseService');
+			do_action('AHEE__EE_System__brew_espresso__after_pue_init');
+		}
+		do_action('AHEE__EE_System__brew_espresso__complete', $this);
+	}
+
+
+	/**
+	 *    set_hooks_for_core
+	 *
+	 * @access public
+	 * @return    void
+	 * @throws EE_Error
+	 */
+	public function set_hooks_for_core()
+	{
+		$this->_deactivate_incompatible_addons();
+		do_action('AHEE__EE_System__set_hooks_for_core');
+		$this->loader->getShared('EventEspresso\core\domain\values\session\SessionLifespan');
+		// caps need to be initialized on every request so that capability maps are set.
+		// @see https://events.codebasehq.com/projects/event-espresso/tickets/8674
+		$this->registry->CAP->init_caps();
+	}
+
+
+	/**
+	 * Using the information gathered in EE_System::_incompatible_addon_error,
+	 * deactivates any addons considered incompatible with the current version of EE
+	 */
+	private function _deactivate_incompatible_addons()
+	{
+		$incompatible_addons = get_option('ee_incompatible_addons', array());
+		if (! empty($incompatible_addons)) {
+			$active_plugins = get_option('active_plugins', array());
+			foreach ($active_plugins as $active_plugin) {
+				foreach ($incompatible_addons as $incompatible_addon) {
+					if (strpos($active_plugin, $incompatible_addon) !== false) {
+						$this->request->unSetRequestParams(['activate'], true);
+						espresso_deactivate_plugin($active_plugin);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    perform_activations_upgrades_and_migrations
+	 *
+	 * @access public
+	 * @return    void
+	 */
+	public function perform_activations_upgrades_and_migrations()
+	{
+		do_action('AHEE__EE_System__perform_activations_upgrades_and_migrations');
+	}
+
+
+	/**
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function load_CPTs_and_session()
+	{
+		do_action('AHEE__EE_System__load_CPTs_and_session__start');
+		$this->register_custom_taxonomies->registerCustomTaxonomies();
+		$this->register_custom_post_types->registerCustomPostTypes();
+		$this->register_custom_taxonomy_terms->registerCustomTaxonomyTerms();
+		// load legacy Custom Post Types and Taxonomies
+		$this->loader->getShared('EE_Register_CPTs');
+		do_action('AHEE__EE_System__load_CPTs_and_session__complete');
+	}
+
+
+	/**
+	 * load_controllers
+	 * this is the best place to load any additional controllers that needs access to EE core.
+	 * it is expected that all basic core EE systems, that are not dependant on the current request are loaded at this
+	 * time
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function load_controllers()
+	{
+		do_action('AHEE__EE_System__load_controllers__start');
+		// let's get it started
+		if (
+			! $this->maintenance_mode->level()
+			&& ($this->request->isFrontend() || $this->request->isFrontAjax())
+		) {
+			do_action('AHEE__EE_System__load_controllers__load_front_controllers');
+			$this->loader->getShared('EE_Front_Controller');
+		} elseif ($this->request->isAdmin() || $this->request->isAdminAjax()) {
+			do_action('AHEE__EE_System__load_controllers__load_admin_controllers');
+			$this->loader->getShared('EE_Admin');
+			$this->loader->getShared(
+				'EventEspresso\core\services\activation\plugin_prompt\DownloadPluginPromptManager'
+			);
+		} elseif ($this->request->isWordPressHeartbeat()) {
+			$this->loader->getShared('EventEspresso\core\domain\services\admin\ajax\WordpressHeartbeat');
+		}
+		do_action('AHEE__EE_System__load_controllers__complete');
+	}
+
+
+	/**
+	 * core_loaded_and_ready
+	 * all of the basic EE core should be loaded at this point and available regardless of M-Mode
+	 *
+	 * @access public
+	 * @return void
+	 * @throws Exception
+	 */
+	public function core_loaded_and_ready()
+	{
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isFrontend()
+			|| $this->request->isIframe()
+			|| $this->request->isWordPressApi()
+		) {
+			try {
+				$this->loader->getShared('EventEspresso\core\services\assets\I18nRegistry', [[]]);
+				$this->loader->getShared('EventEspresso\core\services\assets\Registry');
+				$this->loader->getShared('EventEspresso\core\domain\services\assets\CoreAssetManager');
+				if ($this->canLoadBlocks()) {
+					$this->loader->getShared(
+						'EventEspresso\core\services\editor\BlockRegistrationManager'
+					);
+				}
+			} catch (Exception $exception) {
+				new ExceptionStackTraceDisplay($exception);
+			}
+		}
+		if (
+			$this->request->isAdmin()
+			|| $this->request->isEeAjax()
+			|| $this->request->isFrontend()
+		) {
+			$this->loader->getShared('EE_Session');
+		}
+		do_action('AHEE__EE_System__core_loaded_and_ready');
+		// always load template tags, because it's faster than checking if it's a front-end request, and many page
+		// builders require these even on the front-end
+		require_once EE_PUBLIC . 'template_tags.php';
+		do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
+	}
+
+
+	/**
+	 * initialize
+	 * this is the best place to begin initializing client code
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize()
+	{
+		do_action('AHEE__EE_System__initialize');
+		add_filter(
+			'safe_style_css',
+			function ($styles) {
+				$styles[] = 'display';
+				$styles[] = 'visibility';
+				$styles[] = 'position';
+				$styles[] = 'top';
+				$styles[] = 'right';
+				$styles[] = 'bottom';
+				$styles[] = 'left';
+				$styles[] = 'resize';
+				$styles[] = 'max-width';
+				$styles[] = 'max-height';
+				return $styles;
+			}
+		);
+	}
+
+
+	/**
+	 * initialize_last
+	 * this is run really late during the WP init hook point, and ensures that mostly everything else that needs to
+	 * initialize has done so
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function initialize_last()
+	{
+		do_action('AHEE__EE_System__initialize_last');
+		/** @var EventEspresso\core\domain\services\custom_post_types\RewriteRules $rewrite_rules */
+		$rewrite_rules = $this->loader->getShared(
+			'EventEspresso\core\domain\services\custom_post_types\RewriteRules'
+		);
+		$rewrite_rules->flushRewriteRules();
+		add_action('admin_bar_init', array($this, 'addEspressoToolbar'));
+		if (
+			($this->request->isAjax() || $this->request->isAdmin())
+			&& $this->maintenance_mode->models_can_query()
+		) {
+			$this->loader->getShared('EventEspresso\core\services\privacy\export\PersonalDataExporterManager');
+			$this->loader->getShared('EventEspresso\core\services\privacy\erasure\PersonalDataEraserManager');
+		}
+	}
+
+
+	/**
+	 * @return void
+	 * @throws EE_Error
+	 */
+	public function addEspressoToolbar()
+	{
+		$this->loader->getShared(
+			'EventEspresso\core\domain\services\admin\AdminToolBar',
+			array($this->registry->CAP)
+		);
+	}
+
+
+	/**
+	 * do_not_cache
+	 * sets no cache headers and defines no cache constants for WP plugins
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public static function do_not_cache()
+	{
+		// set no cache constants
+		if (! defined('DONOTCACHEPAGE')) {
+			define('DONOTCACHEPAGE', true);
+		}
+		if (! defined('DONOTCACHCEOBJECT')) {
+			define('DONOTCACHCEOBJECT', true);
+		}
+		if (! defined('DONOTCACHEDB')) {
+			define('DONOTCACHEDB', true);
+		}
+		// add no cache headers
+		add_action('send_headers', array('EE_System', 'nocache_headers'), 10);
+		// plus a little extra for nginx and Google Chrome
+		add_filter('nocache_headers', array('EE_System', 'extra_nocache_headers'), 10, 1);
+		// prevent browsers from prefetching of the rel='next' link, because it may contain content that interferes with the registration process
+		remove_action('wp_head', 'adjacent_posts_rel_link_wp_head');
+	}
+
+
+	/**
+	 *    extra_nocache_headers
+	 *
+	 * @access    public
+	 * @param $headers
+	 * @return    array
+	 */
+	public static function extra_nocache_headers($headers)
+	{
+		// for NGINX
+		$headers['X-Accel-Expires'] = 0;
+		// plus extra for Google Chrome since it doesn't seem to respect "no-cache", but WILL respect "no-store"
+		$headers['Cache-Control'] = 'no-store, no-cache, must-revalidate, max-age=0';
+		return $headers;
+	}
+
+
+	/**
+	 *    nocache_headers
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function nocache_headers()
+	{
+		nocache_headers();
+	}
+
+
+	/**
+	 * simply hooks into "wp_list_pages_exclude" filter (for wp_list_pages method) and makes sure EE critical pages are
+	 * never returned with the function.
+	 *
+	 * @param  array $exclude_array any existing pages being excluded are in this array.
+	 * @return array
+	 */
+	public function remove_pages_from_wp_list_pages($exclude_array)
+	{
+		return array_merge($exclude_array, $this->registry->CFG->core->get_critical_pages_array());
+	}
+
+
+	/**
+	 * Return whether blocks can be registered/loaded or not.
+	 * @return bool
+	 */
+	private function canLoadBlocks()
+	{
+		return apply_filters('FHEE__EE_System__canLoadBlocks', true)
+			   && function_exists('register_block_type')
+			   // don't load blocks if in the Divi page builder editor context
+			   // @see https://github.com/eventespresso/event-espresso-core/issues/814
+			   && ! $this->request->getRequestParam('et_fb', false);
+	}
 }

Spacing +29 added lines, -29 removed lines

@@ -154,7 +154,7 @@ 
         EE_Maintenance_Mode $maintenance_mode = null
     ) {
         // check if class object is instantiated
-        if (! self::$_instance instanceof EE_System) {
+        if ( ! self::$_instance instanceof EE_System) {
             self::$_instance = new self($registry, $loader, $request, $maintenance_mode);
         }
         return self::$_instance;
@@ -281,7 +281,7 @@ 
         $this->capabilities = $this->loader->getShared('EE_Capabilities');
         add_action(
             'AHEE__EE_Capabilities__init_caps__before_initialization',
-            function () {
+            function() {
                 LoaderFactory::getLoader()->getShared('EE_Payment_Method_Manager');
             }
         );
@@ -325,7 +325,7 @@ 
     {
         // set autoloaders for all of the classes implementing EEI_Plugin_API
         // which provide helpers for EE plugin authors to more easily register certain components with EE.
-        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES . 'plugin_api');
+        EEH_Autoloader::instance()->register_autoloaders_for_each_file_in_folder(EE_LIBRARIES.'plugin_api');
     }
 
 
@@ -344,14 +344,14 @@ 
         $load_callback,
         $plugin_file_constant
     ) {
-        if (! defined($version_constant)) {
+        if ( ! defined($version_constant)) {
             return;
         }
         $addon_version = constant($version_constant);
         if ($addon_version && version_compare($addon_version, $min_version_required, '<')) {
             remove_action('AHEE__EE_System__load_espresso_addons', $load_callback);
-            if (! function_exists('deactivate_plugins')) {
-                require_once ABSPATH . 'wp-admin/includes/plugin.php';
+            if ( ! function_exists('deactivate_plugins')) {
+                require_once ABSPATH.'wp-admin/includes/plugin.php';
             }
             deactivate_plugins(plugin_basename(constant($plugin_file_constant)));
             $this->request->unSetRequestParams(['activate', 'activate-multi'], true);
@@ -365,7 +365,7 @@ 
                     $min_version_required
                 ),
                 __FILE__,
-                __FUNCTION__ . "({$addon_name})",
+                __FUNCTION__."({$addon_name})",
                 __LINE__
             );
             EE_Error::get_notices(false, true);
@@ -416,9 +416,9 @@ 
                 array('activate', 'activate-selected'),
                 true
             )
-            && is_readable(EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php')
+            && is_readable(EE_THIRD_PARTY.'wp-api-basic-auth/basic-auth.php')
         ) {
-            include_once EE_THIRD_PARTY . 'wp-api-basic-auth/basic-auth.php';
+            include_once EE_THIRD_PARTY.'wp-api-basic-auth/basic-auth.php';
         }
         do_action('AHEE__EE_System__load_espresso_addons__complete');
     }
@@ -520,11 +520,11 @@ 
     private function fix_espresso_db_upgrade_option($espresso_db_update = null)
     {
         do_action('FHEE__EE_System__manage_fix_espresso_db_upgrade_option__begin', $espresso_db_update);
-        if (! $espresso_db_update) {
+        if ( ! $espresso_db_update) {
             $espresso_db_update = get_option('espresso_db_update');
         }
         // check that option is an array
-        if (! is_array($espresso_db_update)) {
+        if ( ! is_array($espresso_db_update)) {
             // if option is FALSE, then it never existed
             if ($espresso_db_update === false) {
                 // make $espresso_db_update an array and save option with autoload OFF
@@ -544,10 +544,10 @@ 
                     // so it must be numerically-indexed, where values are versions installed...
                     // fix it!
                     $version_string = $should_be_array;
-                    $corrected_db_update[ $version_string ] = array('unknown-date');
+                    $corrected_db_update[$version_string] = array('unknown-date');
                 } else {
                     // ok it checks out
-                    $corrected_db_update[ $should_be_version_string ] = $should_be_array;
+                    $corrected_db_update[$should_be_version_string] = $should_be_array;
                 }
             }
             $espresso_db_update = $corrected_db_update;
@@ -631,13 +631,13 @@ 
      */
     public function update_list_of_installed_versions($version_history = null, $current_version_to_add = null)
     {
-        if (! $version_history) {
+        if ( ! $version_history) {
             $version_history = $this->fix_espresso_db_upgrade_option($version_history);
         }
         if ($current_version_to_add === null) {
             $current_version_to_add = espresso_version();
         }
-        $version_history[ $current_version_to_add ][] = date('Y-m-d H:i:s', time());
+        $version_history[$current_version_to_add][] = date('Y-m-d H:i:s', time());
         // re-save
         return update_option('espresso_db_update', $version_history);
     }
@@ -727,7 +727,7 @@ 
         if ($activation_history_for_addon) {
             // it exists, so this isn't a completely new install
             // check if this version already in that list of previously installed versions
-            if (! isset($activation_history_for_addon[ $version_to_upgrade_to ])) {
+            if ( ! isset($activation_history_for_addon[$version_to_upgrade_to])) {
                 // it a version we haven't seen before
                 if ($version_is_higher === 1) {
                     $req_type = EE_System::req_type_upgrade;
@@ -805,7 +805,7 @@ 
             foreach ($activation_history as $version => $times_activated) {
                 // check there is a record of when this version was activated. Otherwise,
                 // mark it as unknown
-                if (! $times_activated) {
+                if ( ! $times_activated) {
                     $times_activated = array('unknown-date');
                 }
                 if (is_string($times_activated)) {
@@ -910,7 +910,7 @@ 
     private function _parse_model_names()
     {
         // get all the files in the EE_MODELS folder that end in .model.php
-        $models = glob(EE_MODELS . '*.model.php');
+        $models = glob(EE_MODELS.'*.model.php');
         $model_names = array();
         $non_abstract_db_models = array();
         foreach ($models as $model) {
@@ -919,9 +919,9 @@ 
             $short_name = str_replace('EEM_', '', $classname);
             $reflectionClass = new ReflectionClass($classname);
             if ($reflectionClass->isSubclassOf('EEM_Base') && ! $reflectionClass->isAbstract()) {
-                $non_abstract_db_models[ $short_name ] = $classname;
+                $non_abstract_db_models[$short_name] = $classname;
             }
-            $model_names[ $short_name ] = $classname;
+            $model_names[$short_name] = $classname;
         }
         $this->registry->models = apply_filters('FHEE__EE_System__parse_model_names', $model_names);
         $this->registry->non_abstract_db_models = apply_filters(
@@ -956,7 +956,7 @@ 
             )
         );
         if ($domain->isCaffeinated()) {
-            require_once EE_CAFF_PATH . 'brewing_regular.php';
+            require_once EE_CAFF_PATH.'brewing_regular.php';
         }
     }
 
@@ -1038,7 +1038,7 @@ 
         $class_names = EEH_Class_Tools::get_class_names_for_all_callbacks_on_hook(
             'AHEE__EE_System__register_shortcodes_modules_and_addons'
         );
-        if (! empty($class_names)) {
+        if ( ! empty($class_names)) {
             $msg = esc_html__(
                 'The following plugins, addons, or modules appear to be incompatible with this version of Event Espresso and were automatically deactivated to avoid fatal errors:',
                 'event_espresso'
@@ -1050,7 +1050,7 @@ 
                             array('EE_', 'EEM_', 'EED_', 'EES_', 'EEW_'),
                             '',
                             $class_name
-                        ) . '</b></li>';
+                        ).'</b></li>';
             }
             $msg .= '</ul>';
             $msg .= esc_html__(
@@ -1119,7 +1119,7 @@ 
     private function _deactivate_incompatible_addons()
     {
         $incompatible_addons = get_option('ee_incompatible_addons', array());
-        if (! empty($incompatible_addons)) {
+        if ( ! empty($incompatible_addons)) {
             $active_plugins = get_option('active_plugins', array());
             foreach ($active_plugins as $active_plugin) {
                 foreach ($incompatible_addons as $incompatible_addon) {
@@ -1232,7 +1232,7 @@ 
         do_action('AHEE__EE_System__core_loaded_and_ready');
         // always load template tags, because it's faster than checking if it's a front-end request, and many page
         // builders require these even on the front-end
-        require_once EE_PUBLIC . 'template_tags.php';
+        require_once EE_PUBLIC.'template_tags.php';
         do_action('AHEE__EE_System__set_hooks_for_shortcodes_modules_and_addons');
     }
 
@@ -1249,7 +1249,7 @@ 
         do_action('AHEE__EE_System__initialize');
         add_filter(
             'safe_style_css',
-            function ($styles) {
+            function($styles) {
                 $styles[] = 'display';
                 $styles[] = 'visibility';
                 $styles[] = 'position';
@@ -1316,13 +1316,13 @@ 
     public static function do_not_cache()
     {
         // set no cache constants
-        if (! defined('DONOTCACHEPAGE')) {
+        if ( ! defined('DONOTCACHEPAGE')) {
             define('DONOTCACHEPAGE', true);
         }
-        if (! defined('DONOTCACHCEOBJECT')) {
+        if ( ! defined('DONOTCACHCEOBJECT')) {
             define('DONOTCACHCEOBJECT', true);
         }
-        if (! defined('DONOTCACHEDB')) {
+        if ( ! defined('DONOTCACHEDB')) {
             define('DONOTCACHEDB', true);
         }
         // add no cache headers

core/EE_Registry.core.php

Indentation +1717 added lines, -1717 removed lines

@@ -22,1721 +22,1721 @@
  */
 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 EEM_Base|bool|null
-     * @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|mixed           null   = failure to load or instantiate class object.
-     *                                   mixed = class loaded and instantiated successfully.
-     *                                   bool   = fail or success when $load_only is true
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     */
-    protected function _load(
-        array $file_paths = [],
-        string $class_prefix = 'EE_',
-        string $class_name = '',
-        string $type = 'class',
-        array $arguments = [],
-        bool $from_db = false,
-        bool $cache = true,
-        bool $load_only = false
-    ) {
-        $class_name = ltrim($class_name, '\\');
-        // strip php file extension
-        $class_name = str_replace('.php', '', trim($class_name));
-        // does the class have a prefix ?
-        if (! empty($class_prefix) && $class_prefix !== 'addon') {
-            // make sure $class_prefix is uppercase
-            $class_prefix = strtoupper(trim($class_prefix));
-            // add class prefix ONCE!!!
-            $class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
-        }
-        $class_name   = $this->class_cache->getFqnForAlias($class_name);
-        $class_exists = class_exists($class_name, false);
-        // if we're only loading the class and it already exists, then let's just return true immediately
-        if ($load_only && $class_exists) {
-            return true;
-        }
-        $arguments = is_array($arguments) ? $arguments : [$arguments];
-        // $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
-        // $cache is controlled by individual calls to separate Registry loader methods like load_class()
-        // $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
-        if ($this->_cache_on && $cache && ! $load_only) {
-            // return object if it's already cached
-            $cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
-            if ($cached_class !== null) {
-                return $cached_class;
-            }
-        }
-        // if the class doesn't already exist.. then we need to try and find the file and load it
-        if (! $class_exists) {
-            // get full path to file
-            $path = $this->_resolve_path($class_name, $type, $file_paths);
-            // load the file
-            $loaded = $this->_require_file($path, $class_name, $type, $file_paths);
-            // if we are only loading a file but NOT instantiating an object
-            // then return boolean for whether class was loaded or not
-            if ($load_only) {
-                return $loaded;
-            }
-            // if an object was expected but loading failed, then return nothing
-            if (! $loaded) {
-                return null;
-            }
-        }
-        // instantiate the requested object
-        $class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
-        if ($this->_cache_on && $cache) {
-            // save it for later... kinda like gum  { : $
-            $this->_set_cached_class(
-                $class_obj,
-                $class_name,
-                $class_prefix,
-                $from_db,
-                $arguments
-            );
-        }
-        $this->_cache_on = true;
-        return $class_obj;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $default have to specify something, but not anything that will conflict
-     * @return mixed|string
-     */
-    protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
-    {
-        return $this->_class_abbreviations[ $class_name ] ?? $default;
-    }
-
-
-    /**
-     * attempts to find a cached version of the requested class
-     * by looking in the following places:
-     *        $this->{$class_abbreviation}            ie:    $this->CART
-     *        $this->{$class_name}                        ie:    $this->Some_Class
-     *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
-     *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
-     *
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param array  $arguments
-     * @return mixed
-     */
-    protected function _get_cached_class(
-        string $class_name,
-        string $class_prefix = '',
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry') {
-            return $this;
-        }
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            return $this->{$class_abbreviation};
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            return $this->{$class_name};
-        }
-        if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
-            return $this->addons->get($class_name);
-        }
-        $object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($object_identifier)) {
-            return $this->LIB->get($object_identifier);
-        }
-        foreach ($this->LIB as $key => $object) {
-            if (
-                // request does not contain new arguments and therefore no args identifier
-                ! $this->object_identifier->hasArguments($object_identifier)
-                // but previously cached class with args was found
-                && $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
-            ) {
-                return $object;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * removes a cached version of the requested class
-     *
-     * @param string  $class_name
-     * @param boolean $addon
-     * @param array   $arguments
-     * @return boolean
-     */
-    public function clear_cached_class(
-        string $class_name,
-        bool $addon = false,
-        array $arguments = []
-    ): bool {
-        $class_abbreviation = $this->get_class_abbreviation($class_name);
-        // check if class has already been loaded, and return it if it has been
-        if (isset($this->{$class_abbreviation})) {
-            $this->{$class_abbreviation} = null;
-            return true;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (isset($this->{$class_name})) {
-            $this->{$class_name} = null;
-            return true;
-        }
-        if ($addon && $this->addons->has($class_name)) {
-            $this->addons->remove($class_name);
-            return true;
-        }
-        $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-        if ($this->LIB->has($class_name)) {
-            $this->LIB->remove($class_name);
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * _set_cached_class
-     * attempts to cache the instantiated class locally
-     * in one of the following places, in the following order:
-     *        $this->{class_abbreviation}   ie:    $this->CART
-     *        $this->{$class_name}          ie:    $this->Some_Class
-     *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
-     *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
-     *
-     * @param object $class_obj
-     * @param string $class_name
-     * @param string $class_prefix
-     * @param bool   $from_db
-     * @param array  $arguments
-     * @return void
-     */
-    protected function _set_cached_class(
-        $class_obj,
-        string $class_name,
-        string $class_prefix = '',
-        bool $from_db = false,
-        array $arguments = []
-    ) {
-        if ($class_name === 'EE_Registry' || empty($class_obj)) {
-            return;
-        }
-        // return newly instantiated class
-        $class_abbreviation = $this->get_class_abbreviation($class_name, '');
-        if ($class_abbreviation) {
-            $this->{$class_abbreviation} = $class_obj;
-            return;
-        }
-        $class_name = str_replace('\\', '_', $class_name);
-        if (property_exists($this, $class_name)) {
-            $this->{$class_name} = $class_obj;
-            return;
-        }
-        if ($class_prefix === 'addon') {
-            $this->addons->add($class_name, $class_obj);
-            return;
-        }
-        if (! $from_db) {
-            $class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
-            $this->LIB->add($class_name, $class_obj);
-        }
-    }
-
-
-    /**
-     * attempts to find a full valid filepath for the requested class.
-     * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
-     * then returns that path if the target file has been found and is readable
-     *
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return string | bool
-     */
-    protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
-    {
-        // make sure $file_paths is an array
-        $file_paths = is_array($file_paths)
-            ? $file_paths
-            : [$file_paths];
-        // cycle thru paths
-        foreach ($file_paths as $key => $file_path) {
-            // convert all separators to proper /, if no filepath, then use EE_CLASSES
-            $file_path = $file_path
-                ? str_replace(['/', '\\'], '/', $file_path)
-                : EE_CLASSES;
-            // prep file type
-            $type = ! empty($type)
-                ? trim($type, '.') . '.'
-                : '';
-            // build full file path
-            $file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
-            // does the file exist and can be read ?
-            if (is_readable($file_paths[ $key ])) {
-                return $file_paths[ $key ];
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * basically just performs a require_once()
-     * but with some error handling
-     *
-     * @param string $path
-     * @param string $class_name
-     * @param string $type
-     * @param array  $file_paths
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
-    {
-        $this->resolve_legacy_class_parent($class_name);
-        // don't give up! you gotta...
-        try {
-            // does the file exist and can it be read ?
-            if (! $path) {
-                // just in case the file has already been autoloaded,
-                // but discrepancies in the naming schema are preventing it from
-                // being loaded via one of the EE_Registry::load_*() methods,
-                // then let's try one last hail mary before throwing an exception
-                // and call class_exists() again, but with autoloading turned ON
-                if (class_exists($class_name)) {
-                    return true;
-                }
-                // so sorry, can't find the file
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
-                            'event_espresso'
-                        ),
-                        trim($type, '.'),
-                        $class_name,
-                        '<br />' . implode(',<br />', $file_paths)
-                    )
-                );
-            }
-            // get the file
-            require_once($path);
-            // if the class isn't already declared somewhere
-            if (class_exists($class_name, false) === false) {
-                // so sorry, not a class
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The %s file %s does not appear to contain the %s Class.',
-                            'event_espresso'
-                        ),
-                        $type,
-                        $path,
-                        $class_name
-                    )
-                );
-            }
-        } catch (EE_Error $e) {
-            $e->get_error();
-            return false;
-        }
-        return true;
-    }
-
-
-    /**
-     * Some of our legacy classes that extended a parent class would simply use a require() statement
-     * before their class declaration in order to ensure that the parent class was loaded.
-     * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
-     * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
-     *
-     * @param string $class_name
-     */
-    protected function resolve_legacy_class_parent(string $class_name = '')
-    {
-        try {
-            $legacy_parent_class_map = [
-                'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
-            ];
-            if (isset($legacy_parent_class_map[ $class_name ])) {
-                require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
-            }
-        } catch (Exception $exception) {
-        }
-    }
-
-
-    /**
-     * _create_object
-     * Attempts to instantiate the requested class via any of the
-     * commonly used instantiation methods employed throughout EE.
-     * The priority for instantiation is as follows:
-     *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
-     *        - model objects via their 'new_instance_from_db' method
-     *        - model objects via their 'new_instance' method
-     *        - "singleton" classes" via their 'instance' method
-     *    - standard instantiable classes via their __constructor
-     * Prior to instantiation, if the classname exists in the dependency_map,
-     * then the constructor for the requested class will be examined to determine
-     * if any dependencies exist, and if they can be injected.
-     * If so, then those classes will be added to the array of arguments passed to the constructor
-     *
-     * @param string $class_name
-     * @param array  $arguments
-     * @param string $type
-     * @param bool   $from_db
-     * @return null|object|bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_object(
-        string $class_name,
-        array $arguments = [],
-        string $type = '',
-        bool $from_db = false
-    ) {
-        // create reflection
-        $reflector = $this->mirror->getReflectionClass($class_name);
-        // make sure arguments are an array
-        $arguments = is_array($arguments)
-            ? $arguments
-            : [$arguments];
-        // and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
-        // else wrap it in an additional array so that it doesn't get split into multiple parameters
-        $arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
-            ? $arguments
-            : [$arguments];
-        // attempt to inject dependencies ?
-        if ($this->_dependency_map->has($class_name)) {
-            $arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
-        }
-        // instantiate the class if possible
-        if ($reflector->isAbstract()) {
-            // nothing to instantiate, loading file was enough
-            // does not throw an exception so $instantiation_mode is unused
-            // $instantiation_mode = "1) no constructor abstract class";
-            return true;
-        }
-        if (
-            empty($arguments)
-            && $this->mirror->getConstructorFromReflection($reflector) === null
-            && $reflector->isInstantiable()
-        ) {
-            // no constructor = static methods only... nothing to instantiate, loading file was enough
-            // $instantiation_mode = "2) no constructor but instantiable";
-            return $reflector->newInstance();
-        }
-        if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
-            // $instantiation_mode = "3) new_instance_from_db()";
-            return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
-        }
-        if (method_exists($class_name, 'new_instance')) {
-            // $instantiation_mode = "4) new_instance()";
-            return call_user_func_array([$class_name, 'new_instance'], $arguments);
-        }
-        if (method_exists($class_name, 'instance')) {
-            // $instantiation_mode = "5) instance()";
-            return call_user_func_array([$class_name, 'instance'], $arguments);
-        }
-        if ($reflector->isInstantiable()) {
-            // $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->isAlias($param_class, $class_name)
-                ? $this->class_cache->getFqnForAlias($param_class, $class_name)
-                : $param_class;
-            // param is not even a class
-            if (
-                ! empty($param_class)
-                && ! class_exists($param_class, false)
-                // and something already exists in the incoming arguments for this param
-                && array_key_exists($index, $argument_keys)
-                && isset($arguments[ $argument_keys[ $index ] ])
-            ) {
-                // so let's skip this argument and move on to the next
-                continue;
-            }
-            // parameter is type hinted as a class
-            if ($param_class !== null) {
-                // parameter exists as an incoming argument, AND it's the correct class
-                if (
-                    array_key_exists($index, $argument_keys)
-                    && isset($arguments[ $argument_keys[ $index ] ])
-                    && $arguments[ $argument_keys[ $index ] ] instanceof $param_class
-                ) {
-                    // skip this argument and move on to the next
-                    continue;
-                }
-                // parameter should be injected
-                if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
-                    $arguments = $this->_resolve_dependency(
-                        $class_name,
-                        $param_class,
-                        $arguments,
-                        $index
-                    );
-                }
-            }
-            if (empty($arguments[ $index ])) {
-                $default_value = $this->mirror->getParameterDefaultValue(
-                    $param,
-                    $class_name,
-                    $index
-                );
-                // if there's no default value, and the incoming argument is an array (albeit empty), then use that
-                $arguments[ $index ] = $default_value === null
-                                       && isset($arguments[ $index ])
-                                       && is_array($arguments[ $index ])
-                    ? $arguments[ $index ]
-                    : $default_value;
-            }
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @param string $param_class
-     * @param array  $arguments
-     * @param mixed  $index
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
-    {
-        $dependency = null;
-        // should dependency be loaded from cache ?
-        $cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
-            $class_name,
-            $param_class
-        );
-        $cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
-        // we might have a dependency...
-        // let's MAYBE try and find it in our cache if that's what's been requested
-        $cached_class = $cache_on
-            ? $this->_get_cached_class($param_class)
-            : null;
-        // and grab it if it exists
-        if ($cached_class instanceof $param_class) {
-            $dependency = $cached_class;
-        } elseif ($param_class !== $class_name) {
-            // obtain the loader method from the dependency map
-            $loader = $this->_dependency_map->class_loader($param_class);
-            // is loader a custom closure ?
-            if ($loader instanceof Closure) {
-                $dependency = $loader($arguments);
-            } else {
-                // set the cache on property for the recursive loading call
-                $this->_cache_on = $cache_on;
-                // if not, then let's try and load it via the registry
-                if ($loader && method_exists($this, $loader)) {
-                    $dependency = $this->{$loader}($param_class);
-                } else {
-                    $dependency = LoaderFactory::getLoader()->load(
-                        $param_class,
-                        [],
-                        $cache_on
-                    );
-                }
-            }
-        }
-        // did we successfully find the correct dependency ?
-        if ($dependency instanceof $param_class) {
-            // then let's inject it into the incoming array of arguments at the correct location
-            $arguments[ $index ] = $dependency;
-        }
-        return $arguments;
-    }
-
-
-    /**
-     * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
-     *
-     * @param string $classname PLEASE NOTE: the class name needs to match what's registered
-     *                          in the EE_Dependency_Map::$_class_loaders array,
-     *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
-     * @param array  $arguments
-     * @return object
-     */
-    public static function factory(string $classname, array $arguments = [])
-    {
-        $loader = self::instance()->_dependency_map->class_loader($classname);
-        if ($loader instanceof Closure) {
-            return $loader($arguments);
-        }
-        if (method_exists(self::instance(), $loader)) {
-            return self::instance()->{$loader}($classname, $arguments);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the addon by its class name
-     *
-     * @param string $class_name
-     * @return EE_Addon
-     */
-    public function getAddon(string $class_name): ?EE_Addon
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        return $this->addons->{$class_name} ?? null;
-    }
-
-
-    /**
-     * removes the addon from the internal cache
-     *
-     * @param string $class_name
-     * @return void
-     */
-    public function removeAddon(string $class_name)
-    {
-        $class_name = str_replace('\\', '_', $class_name);
-        $this->addons->remove($class_name);
-    }
-
-
-    /**
-     * Gets the addon by its name/slug (not classname. For that, just
-     * use the get_addon() method above
-     *
-     * @param string $name
-     * @return EE_Addon
-     */
-    public function get_addon_by_name(string $name): ?EE_Addon
-    {
-        foreach ($this->addons as $addon) {
-            if ($addon->name() === $name) {
-                return $addon;
-            }
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets an array of all the registered addons, where the keys are their names.
-     * (ie, what each returns for their name() function)
-     * They're already available on EE_Registry::instance()->addons as properties,
-     * where each property's name is the addon's classname,
-     * So if you just want to get the addon by classname,
-     * OR use the get_addon() method above.
-     * PLEASE  NOTE:
-     * addons with Fully Qualified Class Names
-     * have had the namespace separators converted to underscores,
-     * so a classname like Fully\Qualified\ClassName
-     * would have been converted to Fully_Qualified_ClassName
-     *
-     * @return EE_Addon[] where the KEYS are the addon's name()
-     */
-    public function get_addons_by_name(): array
-    {
-        $addons = [];
-        foreach ($this->addons as $addon) {
-            $addons[ $addon->name() ] = $addon;
-        }
-        return $addons;
-    }
-
-
-    /**
-     * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
-     * a stale copy of it around
-     *
-     * @param string $model_name
-     * @return EEM_Base
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function reset_model(string $model_name): ?EEM_Base
-    {
-        $model_class_name = strpos($model_name, 'EEM_') !== 0
-            ? "EEM_$model_name"
-            : $model_name;
-        if (! $this->LIB->has($model_class_name)) {
-            return null;
-        }
-        $model = $this->LIB->get($model_class_name);
-        if (! $model instanceof EEM_Base) {
-            return null;
-        }
-        // get that model reset it and make sure we nuke the old reference to it
-        if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
-            $this->LIB->remove($model_class_name);
-            $this->LIB->add($model_class_name, $model->reset());
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
-                    $model_name
-                )
-            );
-        }
-        return $model;
-    }
-
-
-    /**
-     * Resets the registry.
-     * The criteria for what gets reset is based on what can be shared between sites on the same request when
-     * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
-     * - $_dependency_map
-     * - $_class_abbreviations
-     * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
-     * - $REQ:  Still on the same request so no need to change.
-     * - $CAP: There is no site specific state in the EE_Capability class.
-     * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
-     * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
-     * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
-     *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
-     *             switch or on the restore.
-     * - $modules
-     * - $shortcodes
-     * - $widgets
-     *
-     * @param boolean $hard             [deprecated]
-     * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
-     *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
-     *                                  sure if you CAN currently reinstantiate the singletons at the moment)
-     * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
-     *                                  client
-     *                                  code instead can just change the model context to a different blog id if
-     *                                  necessary
-     * @return EE_Registry
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
-    {
-        $instance            = self::instance();
-        $instance->_cache_on = true;
-        // reset some "special" classes
-        EEH_Activation::reset();
-        $hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
-        $instance->CFG            = EE_Config::reset($hard, $reinstantiate);
-        $instance->CART           = null;
-        $instance->MRM            = null;
-        $instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
-            'EventEspresso\core\services\assets\Registry'
-        );
-        // messages reset
-        EED_Messages::reset();
-        // handle of objects cached on LIB
-        foreach (['LIB', 'modules'] as $cache) {
-            foreach ($instance->{$cache} as $class_name => $class) {
-                if (self::_reset_and_unset_object($class, $reset_models)) {
-                    unset($instance->{$cache}->{$class_name});
-                }
-            }
-        }
-        return $instance;
-    }
-
-
-    /**
-     * if passed object implements ResettableInterface, then call it's reset() method
-     * if passed object implements InterminableInterface, then return false,
-     * to indicate that it should NOT be cleared from the Registry cache
-     *
-     * @param      $object
-     * @param bool $reset_models
-     * @return bool returns true if cached object should be unset
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private static function _reset_and_unset_object($object, bool $reset_models): bool
-    {
-        if (! is_object($object)) {
-            // don't unset anything that's not an object
-            return false;
-        }
-        if ($object instanceof EED_Module) {
-            $object::reset();
-            // don't unset modules
-            return false;
-        }
-        if ($object instanceof ResettableInterface) {
-            if ($object instanceof EEM_Base) {
-                if ($reset_models) {
-                    $object->reset();
-                    return true;
-                }
-                return false;
-            }
-            $object->reset();
-            return true;
-        }
-        if (! $object instanceof InterminableInterface) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all the custom post type models defined
-     *
-     * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
-     */
-    public function cpt_models(): array
-    {
-        $cpt_models = [];
-        foreach ($this->non_abstract_db_models as $short_name => $classname) {
-            if (is_subclass_of($classname, 'EEM_CPT_Base')) {
-                $cpt_models[ $short_name ] = $classname;
-            }
-        }
-        return $cpt_models;
-    }
-
-
-    /**
-     * @return EE_Config
-     */
-    public static function CFG(): EE_Config
-    {
-        return self::instance()->CFG;
-    }
-
-
-    /**
-     * @param string $class_name
-     * @return ReflectionClass
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @deprecated 4.9.62.p
-     */
-    public function get_ReflectionClass(string $class_name): ReflectionClass
-    {
-        return $this->mirror->getReflectionClass($class_name);
-    }
+	/**
+	 * @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 EEM_Base|bool|null
+	 * @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|mixed           null   = failure to load or instantiate class object.
+	 *                                   mixed = class loaded and instantiated successfully.
+	 *                                   bool   = fail or success when $load_only is true
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _load(
+		array $file_paths = [],
+		string $class_prefix = 'EE_',
+		string $class_name = '',
+		string $type = 'class',
+		array $arguments = [],
+		bool $from_db = false,
+		bool $cache = true,
+		bool $load_only = false
+	) {
+		$class_name = ltrim($class_name, '\\');
+		// strip php file extension
+		$class_name = str_replace('.php', '', trim($class_name));
+		// does the class have a prefix ?
+		if (! empty($class_prefix) && $class_prefix !== 'addon') {
+			// make sure $class_prefix is uppercase
+			$class_prefix = strtoupper(trim($class_prefix));
+			// add class prefix ONCE!!!
+			$class_name = $class_prefix . str_replace($class_prefix, '', $class_name);
+		}
+		$class_name   = $this->class_cache->getFqnForAlias($class_name);
+		$class_exists = class_exists($class_name, false);
+		// if we're only loading the class and it already exists, then let's just return true immediately
+		if ($load_only && $class_exists) {
+			return true;
+		}
+		$arguments = is_array($arguments) ? $arguments : [$arguments];
+		// $this->_cache_on is toggled during the recursive loading that can occur with dependency injection
+		// $cache is controlled by individual calls to separate Registry loader methods like load_class()
+		// $load_only is also controlled by individual calls to separate Registry loader methods like load_file()
+		if ($this->_cache_on && $cache && ! $load_only) {
+			// return object if it's already cached
+			$cached_class = $this->_get_cached_class($class_name, $class_prefix, $arguments);
+			if ($cached_class !== null) {
+				return $cached_class;
+			}
+		}
+		// if the class doesn't already exist.. then we need to try and find the file and load it
+		if (! $class_exists) {
+			// get full path to file
+			$path = $this->_resolve_path($class_name, $type, $file_paths);
+			// load the file
+			$loaded = $this->_require_file($path, $class_name, $type, $file_paths);
+			// if we are only loading a file but NOT instantiating an object
+			// then return boolean for whether class was loaded or not
+			if ($load_only) {
+				return $loaded;
+			}
+			// if an object was expected but loading failed, then return nothing
+			if (! $loaded) {
+				return null;
+			}
+		}
+		// instantiate the requested object
+		$class_obj = $this->_create_object($class_name, $arguments, $type, $from_db);
+		if ($this->_cache_on && $cache) {
+			// save it for later... kinda like gum  { : $
+			$this->_set_cached_class(
+				$class_obj,
+				$class_name,
+				$class_prefix,
+				$from_db,
+				$arguments
+			);
+		}
+		$this->_cache_on = true;
+		return $class_obj;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $default have to specify something, but not anything that will conflict
+	 * @return mixed|string
+	 */
+	protected function get_class_abbreviation(string $class_name, string $default = 'FANCY_BATMAN_PANTS')
+	{
+		return $this->_class_abbreviations[ $class_name ] ?? $default;
+	}
+
+
+	/**
+	 * attempts to find a cached version of the requested class
+	 * by looking in the following places:
+	 *        $this->{$class_abbreviation}            ie:    $this->CART
+	 *        $this->{$class_name}                        ie:    $this->Some_Class
+	 *        $this->LIB->{$class_name}                ie:    $this->LIB->Some_Class
+	 *        $this->addon->{$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param array  $arguments
+	 * @return mixed
+	 */
+	protected function _get_cached_class(
+		string $class_name,
+		string $class_prefix = '',
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry') {
+			return $this;
+		}
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			return $this->{$class_abbreviation};
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			return $this->{$class_name};
+		}
+		if ($class_prefix === 'addon' && $this->addons->has($class_name)) {
+			return $this->addons->get($class_name);
+		}
+		$object_identifier = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($object_identifier)) {
+			return $this->LIB->get($object_identifier);
+		}
+		foreach ($this->LIB as $key => $object) {
+			if (
+				// request does not contain new arguments and therefore no args identifier
+				! $this->object_identifier->hasArguments($object_identifier)
+				// but previously cached class with args was found
+				&& $this->object_identifier->fqcnMatchesObjectIdentifier($class_name, $key)
+			) {
+				return $object;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * removes a cached version of the requested class
+	 *
+	 * @param string  $class_name
+	 * @param boolean $addon
+	 * @param array   $arguments
+	 * @return boolean
+	 */
+	public function clear_cached_class(
+		string $class_name,
+		bool $addon = false,
+		array $arguments = []
+	): bool {
+		$class_abbreviation = $this->get_class_abbreviation($class_name);
+		// check if class has already been loaded, and return it if it has been
+		if (isset($this->{$class_abbreviation})) {
+			$this->{$class_abbreviation} = null;
+			return true;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (isset($this->{$class_name})) {
+			$this->{$class_name} = null;
+			return true;
+		}
+		if ($addon && $this->addons->has($class_name)) {
+			$this->addons->remove($class_name);
+			return true;
+		}
+		$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+		if ($this->LIB->has($class_name)) {
+			$this->LIB->remove($class_name);
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * _set_cached_class
+	 * attempts to cache the instantiated class locally
+	 * in one of the following places, in the following order:
+	 *        $this->{class_abbreviation}   ie:    $this->CART
+	 *        $this->{$class_name}          ie:    $this->Some_Class
+	 *        $this->addon->{$$class_name}    ie:    $this->addon->Some_Addon_Class
+	 *        $this->LIB->{$class_name}     ie:    $this->LIB->Some_Class
+	 *
+	 * @param object $class_obj
+	 * @param string $class_name
+	 * @param string $class_prefix
+	 * @param bool   $from_db
+	 * @param array  $arguments
+	 * @return void
+	 */
+	protected function _set_cached_class(
+		$class_obj,
+		string $class_name,
+		string $class_prefix = '',
+		bool $from_db = false,
+		array $arguments = []
+	) {
+		if ($class_name === 'EE_Registry' || empty($class_obj)) {
+			return;
+		}
+		// return newly instantiated class
+		$class_abbreviation = $this->get_class_abbreviation($class_name, '');
+		if ($class_abbreviation) {
+			$this->{$class_abbreviation} = $class_obj;
+			return;
+		}
+		$class_name = str_replace('\\', '_', $class_name);
+		if (property_exists($this, $class_name)) {
+			$this->{$class_name} = $class_obj;
+			return;
+		}
+		if ($class_prefix === 'addon') {
+			$this->addons->add($class_name, $class_obj);
+			return;
+		}
+		if (! $from_db) {
+			$class_name = $this->object_identifier->getIdentifier($class_name, $arguments);
+			$this->LIB->add($class_name, $class_obj);
+		}
+	}
+
+
+	/**
+	 * attempts to find a full valid filepath for the requested class.
+	 * loops thru each of the base paths in the $file_paths array and appends : "{classname} . {file type} . php"
+	 * then returns that path if the target file has been found and is readable
+	 *
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return string | bool
+	 */
+	protected function _resolve_path(string $class_name, string $type = '', array $file_paths = [])
+	{
+		// make sure $file_paths is an array
+		$file_paths = is_array($file_paths)
+			? $file_paths
+			: [$file_paths];
+		// cycle thru paths
+		foreach ($file_paths as $key => $file_path) {
+			// convert all separators to proper /, if no filepath, then use EE_CLASSES
+			$file_path = $file_path
+				? str_replace(['/', '\\'], '/', $file_path)
+				: EE_CLASSES;
+			// prep file type
+			$type = ! empty($type)
+				? trim($type, '.') . '.'
+				: '';
+			// build full file path
+			$file_paths[ $key ] = rtrim($file_path, '/') . '/' . $class_name . '.' . $type . 'php';
+			// does the file exist and can be read ?
+			if (is_readable($file_paths[ $key ])) {
+				return $file_paths[ $key ];
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * basically just performs a require_once()
+	 * but with some error handling
+	 *
+	 * @param string $path
+	 * @param string $class_name
+	 * @param string $type
+	 * @param array  $file_paths
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _require_file(string $path, string $class_name, string $type = '', array $file_paths = []): bool
+	{
+		$this->resolve_legacy_class_parent($class_name);
+		// don't give up! you gotta...
+		try {
+			// does the file exist and can it be read ?
+			if (! $path) {
+				// just in case the file has already been autoloaded,
+				// but discrepancies in the naming schema are preventing it from
+				// being loaded via one of the EE_Registry::load_*() methods,
+				// then let's try one last hail mary before throwing an exception
+				// and call class_exists() again, but with autoloading turned ON
+				if (class_exists($class_name)) {
+					return true;
+				}
+				// so sorry, can't find the file
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %1$s file %2$s could not be located or is not readable due to file permissions. Please ensure that the following filepath(s) are correct: %3$s',
+							'event_espresso'
+						),
+						trim($type, '.'),
+						$class_name,
+						'<br />' . implode(',<br />', $file_paths)
+					)
+				);
+			}
+			// get the file
+			require_once($path);
+			// if the class isn't already declared somewhere
+			if (class_exists($class_name, false) === false) {
+				// so sorry, not a class
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The %s file %s does not appear to contain the %s Class.',
+							'event_espresso'
+						),
+						$type,
+						$path,
+						$class_name
+					)
+				);
+			}
+		} catch (EE_Error $e) {
+			$e->get_error();
+			return false;
+		}
+		return true;
+	}
+
+
+	/**
+	 * Some of our legacy classes that extended a parent class would simply use a require() statement
+	 * before their class declaration in order to ensure that the parent class was loaded.
+	 * This is not ideal, but it's nearly impossible to determine the parent class of a non-namespaced class,
+	 * without triggering a fatal error because the parent class has yet to be loaded and therefore doesn't exist.
+	 *
+	 * @param string $class_name
+	 */
+	protected function resolve_legacy_class_parent(string $class_name = '')
+	{
+		try {
+			$legacy_parent_class_map = [
+				'EE_Payment_Processor' => 'core/business/EE_Processor_Base.class.php',
+			];
+			if (isset($legacy_parent_class_map[ $class_name ])) {
+				require_once EE_PLUGIN_DIR_PATH . $legacy_parent_class_map[ $class_name ];
+			}
+		} catch (Exception $exception) {
+		}
+	}
+
+
+	/**
+	 * _create_object
+	 * Attempts to instantiate the requested class via any of the
+	 * commonly used instantiation methods employed throughout EE.
+	 * The priority for instantiation is as follows:
+	 *        - abstract classes or any class flagged as "load only" (no instantiation occurs)
+	 *        - model objects via their 'new_instance_from_db' method
+	 *        - model objects via their 'new_instance' method
+	 *        - "singleton" classes" via their 'instance' method
+	 *    - standard instantiable classes via their __constructor
+	 * Prior to instantiation, if the classname exists in the dependency_map,
+	 * then the constructor for the requested class will be examined to determine
+	 * if any dependencies exist, and if they can be injected.
+	 * If so, then those classes will be added to the array of arguments passed to the constructor
+	 *
+	 * @param string $class_name
+	 * @param array  $arguments
+	 * @param string $type
+	 * @param bool   $from_db
+	 * @return null|object|bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_object(
+		string $class_name,
+		array $arguments = [],
+		string $type = '',
+		bool $from_db = false
+	) {
+		// create reflection
+		$reflector = $this->mirror->getReflectionClass($class_name);
+		// make sure arguments are an array
+		$arguments = is_array($arguments)
+			? $arguments
+			: [$arguments];
+		// and if arguments array is numerically and sequentially indexed, then we want it to remain as is,
+		// else wrap it in an additional array so that it doesn't get split into multiple parameters
+		$arguments = $this->_array_is_numerically_and_sequentially_indexed($arguments)
+			? $arguments
+			: [$arguments];
+		// attempt to inject dependencies ?
+		if ($this->_dependency_map->has($class_name)) {
+			$arguments = $this->_resolve_dependencies($reflector, $class_name, $arguments);
+		}
+		// instantiate the class if possible
+		if ($reflector->isAbstract()) {
+			// nothing to instantiate, loading file was enough
+			// does not throw an exception so $instantiation_mode is unused
+			// $instantiation_mode = "1) no constructor abstract class";
+			return true;
+		}
+		if (
+			empty($arguments)
+			&& $this->mirror->getConstructorFromReflection($reflector) === null
+			&& $reflector->isInstantiable()
+		) {
+			// no constructor = static methods only... nothing to instantiate, loading file was enough
+			// $instantiation_mode = "2) no constructor but instantiable";
+			return $reflector->newInstance();
+		}
+		if ($from_db && method_exists($class_name, 'new_instance_from_db')) {
+			// $instantiation_mode = "3) new_instance_from_db()";
+			return call_user_func_array([$class_name, 'new_instance_from_db'], $arguments);
+		}
+		if (method_exists($class_name, 'new_instance')) {
+			// $instantiation_mode = "4) new_instance()";
+			return call_user_func_array([$class_name, 'new_instance'], $arguments);
+		}
+		if (method_exists($class_name, 'instance')) {
+			// $instantiation_mode = "5) instance()";
+			return call_user_func_array([$class_name, 'instance'], $arguments);
+		}
+		if ($reflector->isInstantiable()) {
+			// $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->isAlias($param_class, $class_name)
+				? $this->class_cache->getFqnForAlias($param_class, $class_name)
+				: $param_class;
+			// param is not even a class
+			if (
+				! empty($param_class)
+				&& ! class_exists($param_class, false)
+				// and something already exists in the incoming arguments for this param
+				&& array_key_exists($index, $argument_keys)
+				&& isset($arguments[ $argument_keys[ $index ] ])
+			) {
+				// so let's skip this argument and move on to the next
+				continue;
+			}
+			// parameter is type hinted as a class
+			if ($param_class !== null) {
+				// parameter exists as an incoming argument, AND it's the correct class
+				if (
+					array_key_exists($index, $argument_keys)
+					&& isset($arguments[ $argument_keys[ $index ] ])
+					&& $arguments[ $argument_keys[ $index ] ] instanceof $param_class
+				) {
+					// skip this argument and move on to the next
+					continue;
+				}
+				// parameter should be injected
+				if ($this->_dependency_map->has_dependency_for_class($class_name, $param_class)) {
+					$arguments = $this->_resolve_dependency(
+						$class_name,
+						$param_class,
+						$arguments,
+						$index
+					);
+				}
+			}
+			if (empty($arguments[ $index ])) {
+				$default_value = $this->mirror->getParameterDefaultValue(
+					$param,
+					$class_name,
+					$index
+				);
+				// if there's no default value, and the incoming argument is an array (albeit empty), then use that
+				$arguments[ $index ] = $default_value === null
+									   && isset($arguments[ $index ])
+									   && is_array($arguments[ $index ])
+					? $arguments[ $index ]
+					: $default_value;
+			}
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @param string $param_class
+	 * @param array  $arguments
+	 * @param mixed  $index
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _resolve_dependency(string $class_name, string $param_class, array $arguments, $index): array
+	{
+		$dependency = null;
+		// should dependency be loaded from cache ?
+		$cache_on = $this->_dependency_map->loading_strategy_for_class_dependency(
+			$class_name,
+			$param_class
+		);
+		$cache_on = $cache_on !== EE_Dependency_Map::load_new_object;
+		// we might have a dependency...
+		// let's MAYBE try and find it in our cache if that's what's been requested
+		$cached_class = $cache_on
+			? $this->_get_cached_class($param_class)
+			: null;
+		// and grab it if it exists
+		if ($cached_class instanceof $param_class) {
+			$dependency = $cached_class;
+		} elseif ($param_class !== $class_name) {
+			// obtain the loader method from the dependency map
+			$loader = $this->_dependency_map->class_loader($param_class);
+			// is loader a custom closure ?
+			if ($loader instanceof Closure) {
+				$dependency = $loader($arguments);
+			} else {
+				// set the cache on property for the recursive loading call
+				$this->_cache_on = $cache_on;
+				// if not, then let's try and load it via the registry
+				if ($loader && method_exists($this, $loader)) {
+					$dependency = $this->{$loader}($param_class);
+				} else {
+					$dependency = LoaderFactory::getLoader()->load(
+						$param_class,
+						[],
+						$cache_on
+					);
+				}
+			}
+		}
+		// did we successfully find the correct dependency ?
+		if ($dependency instanceof $param_class) {
+			// then let's inject it into the incoming array of arguments at the correct location
+			$arguments[ $index ] = $dependency;
+		}
+		return $arguments;
+	}
+
+
+	/**
+	 * call any loader that's been registered in the EE_Dependency_Map::$_class_loaders array
+	 *
+	 * @param string $classname PLEASE NOTE: the class name needs to match what's registered
+	 *                          in the EE_Dependency_Map::$_class_loaders array,
+	 *                          including the class prefix, ie: "EE_", "EEM_", "EEH_", etc
+	 * @param array  $arguments
+	 * @return object
+	 */
+	public static function factory(string $classname, array $arguments = [])
+	{
+		$loader = self::instance()->_dependency_map->class_loader($classname);
+		if ($loader instanceof Closure) {
+			return $loader($arguments);
+		}
+		if (method_exists(self::instance(), $loader)) {
+			return self::instance()->{$loader}($classname, $arguments);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the addon by its class name
+	 *
+	 * @param string $class_name
+	 * @return EE_Addon
+	 */
+	public function getAddon(string $class_name): ?EE_Addon
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		return $this->addons->{$class_name} ?? null;
+	}
+
+
+	/**
+	 * removes the addon from the internal cache
+	 *
+	 * @param string $class_name
+	 * @return void
+	 */
+	public function removeAddon(string $class_name)
+	{
+		$class_name = str_replace('\\', '_', $class_name);
+		$this->addons->remove($class_name);
+	}
+
+
+	/**
+	 * Gets the addon by its name/slug (not classname. For that, just
+	 * use the get_addon() method above
+	 *
+	 * @param string $name
+	 * @return EE_Addon
+	 */
+	public function get_addon_by_name(string $name): ?EE_Addon
+	{
+		foreach ($this->addons as $addon) {
+			if ($addon->name() === $name) {
+				return $addon;
+			}
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets an array of all the registered addons, where the keys are their names.
+	 * (ie, what each returns for their name() function)
+	 * They're already available on EE_Registry::instance()->addons as properties,
+	 * where each property's name is the addon's classname,
+	 * So if you just want to get the addon by classname,
+	 * OR use the get_addon() method above.
+	 * PLEASE  NOTE:
+	 * addons with Fully Qualified Class Names
+	 * have had the namespace separators converted to underscores,
+	 * so a classname like Fully\Qualified\ClassName
+	 * would have been converted to Fully_Qualified_ClassName
+	 *
+	 * @return EE_Addon[] where the KEYS are the addon's name()
+	 */
+	public function get_addons_by_name(): array
+	{
+		$addons = [];
+		foreach ($this->addons as $addon) {
+			$addons[ $addon->name() ] = $addon;
+		}
+		return $addons;
+	}
+
+
+	/**
+	 * Resets the specified model's instance AND makes sure EE_Registry doesn't keep
+	 * a stale copy of it around
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function reset_model(string $model_name): ?EEM_Base
+	{
+		$model_class_name = strpos($model_name, 'EEM_') !== 0
+			? "EEM_$model_name"
+			: $model_name;
+		if (! $this->LIB->has($model_class_name)) {
+			return null;
+		}
+		$model = $this->LIB->get($model_class_name);
+		if (! $model instanceof EEM_Base) {
+			return null;
+		}
+		// get that model reset it and make sure we nuke the old reference to it
+		if ($model instanceof $model_class_name && is_callable([$model_class_name, 'reset'])) {
+			$this->LIB->remove($model_class_name);
+			$this->LIB->add($model_class_name, $model->reset());
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('Model %s does not have a method "reset"', 'event_espresso'),
+					$model_name
+				)
+			);
+		}
+		return $model;
+	}
+
+
+	/**
+	 * Resets the registry.
+	 * The criteria for what gets reset is based on what can be shared between sites on the same request when
+	 * switch_to_blog is used in a multisite install.  Here is a list of things that are NOT reset.
+	 * - $_dependency_map
+	 * - $_class_abbreviations
+	 * - $NET_CFG (EE_Network_Config): The config is shared network wide so no need to reset.
+	 * - $REQ:  Still on the same request so no need to change.
+	 * - $CAP: There is no site specific state in the EE_Capability class.
+	 * - $SSN: Although ideally, the session should not be shared between site switches, we can't reset it because only
+	 * one Session can be active in a single request.  Resetting could resolve in "headers already sent" errors.
+	 * - $addons:  In multisite, the state of the addons is something controlled via hooks etc in a normal request.  So
+	 *             for now, we won't reset the addons because it could break calls to an add-ons class/methods in the
+	 *             switch or on the restore.
+	 * - $modules
+	 * - $shortcodes
+	 * - $widgets
+	 *
+	 * @param boolean $hard             [deprecated]
+	 * @param boolean $reinstantiate    whether to create new instances of EE_Registry's singletons too,
+	 *                                  or just reset without re-instantiating (handy to set to FALSE if you're not
+	 *                                  sure if you CAN currently reinstantiate the singletons at the moment)
+	 * @param bool    $reset_models     Defaults to true.  When false, then the models are not reset.  This is so
+	 *                                  client
+	 *                                  code instead can just change the model context to a different blog id if
+	 *                                  necessary
+	 * @return EE_Registry
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset(bool $hard = false, bool $reinstantiate = true, bool $reset_models = true): EE_Registry
+	{
+		$instance            = self::instance();
+		$instance->_cache_on = true;
+		// reset some "special" classes
+		EEH_Activation::reset();
+		$hard                     = apply_filters('FHEE__EE_Registry__reset__hard', $hard);
+		$instance->CFG            = EE_Config::reset($hard, $reinstantiate);
+		$instance->CART           = null;
+		$instance->MRM            = null;
+		$instance->AssetsRegistry = LoaderFactory::getLoader()->getShared(
+			'EventEspresso\core\services\assets\Registry'
+		);
+		// messages reset
+		EED_Messages::reset();
+		// handle of objects cached on LIB
+		foreach (['LIB', 'modules'] as $cache) {
+			foreach ($instance->{$cache} as $class_name => $class) {
+				if (self::_reset_and_unset_object($class, $reset_models)) {
+					unset($instance->{$cache}->{$class_name});
+				}
+			}
+		}
+		return $instance;
+	}
+
+
+	/**
+	 * if passed object implements ResettableInterface, then call it's reset() method
+	 * if passed object implements InterminableInterface, then return false,
+	 * to indicate that it should NOT be cleared from the Registry cache
+	 *
+	 * @param      $object
+	 * @param bool $reset_models
+	 * @return bool returns true if cached object should be unset
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private static function _reset_and_unset_object($object, bool $reset_models): bool
+	{
+		if (! is_object($object)) {
+			// don't unset anything that's not an object
+			return false;
+		}
+		if ($object instanceof EED_Module) {
+			$object::reset();
+			// don't unset modules
+			return false;
+		}
+		if ($object instanceof ResettableInterface) {
+			if ($object instanceof EEM_Base) {
+				if ($reset_models) {
+					$object->reset();
+					return true;
+				}
+				return false;
+			}
+			$object->reset();
+			return true;
+		}
+		if (! $object instanceof InterminableInterface) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all the custom post type models defined
+	 *
+	 * @return array keys are model "short names" (Eg "Event") and keys are classnames (eg "EEM_Event")
+	 */
+	public function cpt_models(): array
+	{
+		$cpt_models = [];
+		foreach ($this->non_abstract_db_models as $short_name => $classname) {
+			if (is_subclass_of($classname, 'EEM_CPT_Base')) {
+				$cpt_models[ $short_name ] = $classname;
+			}
+		}
+		return $cpt_models;
+	}
+
+
+	/**
+	 * @return EE_Config
+	 */
+	public static function CFG(): EE_Config
+	{
+		return self::instance()->CFG;
+	}
+
+
+	/**
+	 * @param string $class_name
+	 * @return ReflectionClass
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @deprecated 4.9.62.p
+	 */
+	public function get_ReflectionClass(string $class_name): ReflectionClass
+	{
+		return $this->mirror->getReflectionClass($class_name);
+	}
 }