eventespresso / event-espresso-core

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

Spacing +65 added lines, -65 removed lines

@@ -99,7 +99,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -140,7 +140,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return [];
             }
             // get the model for this version
@@ -203,11 +203,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,
@@ -216,9 +216,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()
                 );
             }
@@ -240,9 +240,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)
             );
@@ -292,7 +292,7 @@ 
         $controller = self::getReadController();
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -376,7 +376,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),
@@ -388,7 +388,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 */
@@ -435,7 +435,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
@@ -499,13 +499,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 */
@@ -525,7 +525,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'];
@@ -564,7 +564,7 @@ 
      */
     public function getEntitiesFromRelation($id, 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__(
@@ -610,7 +610,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'])) {
@@ -658,7 +658,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
@@ -712,7 +712,7 @@ 
             $rest_request,
             $has_protected_fields
         );
-        $entity_array                       = apply_filters(
+        $entity_array = apply_filters(
             'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
             $entity_array,
             $model,
@@ -744,7 +744,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,
@@ -779,7 +779,7 @@ 
      */
     protected function addProtectedProperty(EEM_Base $model, array $results_so_far, bool $protected): array
     {
-        if (! $protected || ! $model->hasPassword()) {
+        if ( ! $protected || ! $model->hasPassword()) {
             return $results_so_far;
         }
         $password_field  = $model->getPasswordField();
@@ -828,8 +828,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',
@@ -839,7 +839,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,
@@ -850,14 +850,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'),
                 ];
@@ -867,7 +867,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'),
                 ];
@@ -898,10 +898,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) {
@@ -958,7 +958,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;
     }
@@ -984,7 +984,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()]
                     ),
                 ],
             ];
@@ -1001,12 +1001,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
                         ),
@@ -1046,12 +1046,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
             );
@@ -1079,7 +1079,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,
@@ -1100,7 +1100,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;
@@ -1127,7 +1127,7 @@ 
         $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 (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
+        if ( ! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
             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();
@@ -1185,13 +1185,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;
@@ -1311,7 +1311,7 @@ 
      */
     public function validateContext(?string $context): string
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1335,7 +1335,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         ];
-        if (! $default_where_conditions) {
+        if ( ! $default_where_conditions) {
             $default_where_conditions = EEM_Base::default_where_conditions_all;
         }
         if (
@@ -1426,14 +1426,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__(
@@ -1490,7 +1490,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;
         }
@@ -1509,9 +1509,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;
@@ -1543,17 +1543,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
@@ -1596,9 +1596,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[] = '*';
@@ -1641,7 +1641,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),
@@ -1653,7 +1653,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(
                     __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                     $context,
@@ -1705,14 +1705,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']
                 )
             ) {
@@ -1726,12 +1726,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();
                 }
             }

Indentation +1684 added lines, -1684 removed lines

@@ -51,1688 +51,1688 @@
  */
 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;
-    }
-
-
-    /**
-     * @return Read
-     */
-    private static function getReadController(): Read
-    {
-        return LoaderFactory::getLoader()->getNew(Read::class);
-    }
-
-
-    /**
-     * 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 = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    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
-                        )
-                    )
-                );
-            }
-            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 = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            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
-     */
-    public 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'];
-        }
-        /** @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 = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    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
-                        )
-                    )
-                );
-            }
-            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 = self::getReadController();
-        try {
-            $controller->setRequestedVersion($version);
-            $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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     */
-    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|null
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws ModelConfigurationException
-     * @throws UnexpectedEntityException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams(
-        array $primary_model_query_params,
-        EE_Model_Relation_Base $relation,
-        WP_REST_Request $request
-    ) {
-        $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 int|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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws ModelConfigurationException
-     * @throws UnexpectedEntityException
-     */
-    public function getEntitiesFromRelation($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
-     */
-    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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     */
-    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 (! $protected || ! $model->hasPassword()) {
-            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 array|int
-     * @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
-     */
-    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
-     * @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 DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws UnexpectedEntityException
-     */
-    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 = null;
-                    }
-                } 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 === null) {
-                    $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 (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
-            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 $array
-     * @return array
-     */
-    private function removeModelNamesFromArray(array $array): array
-    {
-        return array_diff($array, 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 bool            $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
-     *                                          did, let's know about it ASAP, so let the exception bubble up)
-     * @throws EE_Error
-     */
-    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
-     */
-    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);
-        }
-        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 InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ModelConfigurationException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws RestPasswordIncorrectException
-     * @throws RestPasswordRequiredException
-     * @throws UnexpectedEntityException
-     * @throws DomainException
-     */
-    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|null $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, true)) {
-            return $context;
-        }
-        return EEM_Base::caps_read;
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param string $default_where_conditions
-     * @return string
-     */
-    public function validateDefaultQueryParams(string $default_where_conditions): 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_where_conditions) {
-            $default_where_conditions = EEM_Base::default_where_conditions_all;
-        }
-        if (
-            in_array(
-                $default_where_conditions,
-                $valid_default_where_conditions_for_api_calls,
-                true
-            )
-        ) {
-            return $default_where_conditions;
-        }
-        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 InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     * @throws DomainException
-     * @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_query_params['caps'] === EEM_Base::caps_read
-            && empty($query_params['password'])
-            && ! $model->hasPassword()
-            && $model->restrictedByRelatedModelPassword()
-        ) {
-            $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 $model
-     * @param $query_params
-     * @return array
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $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 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(string $include_string, string $model_name = null): 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
-            );
-        }
-        // 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(
-                    __('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]
-            );
-        }
-        // it's not you. It just doesn't exist
-        throw new RestException(
-            sprintf('rest_%s_invalid_id', $lowercase_model_name),
-            sprintf(__('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();
-                }
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 *
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * @return Read
+	 */
+	private static function getReadController(): Read
+	{
+		return LoaderFactory::getLoader()->getNew(Read::class);
+	}
+
+
+	/**
+	 * 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 = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					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
+						)
+					)
+				);
+			}
+			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 = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			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
+	 */
+	public 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'];
+		}
+		/** @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 = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					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
+						)
+					)
+				);
+			}
+			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 = self::getReadController();
+		try {
+			$controller->setRequestedVersion($version);
+			$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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 */
+	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|null
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws ModelConfigurationException
+	 * @throws UnexpectedEntityException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams(
+		array $primary_model_query_params,
+		EE_Model_Relation_Base $relation,
+		WP_REST_Request $request
+	) {
+		$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 int|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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws ModelConfigurationException
+	 * @throws UnexpectedEntityException
+	 */
+	public function getEntitiesFromRelation($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
+	 */
+	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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 */
+	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 (! $protected || ! $model->hasPassword()) {
+			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 array|int
+	 * @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
+	 */
+	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
+	 * @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 DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws UnexpectedEntityException
+	 */
+	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 = null;
+					}
+				} 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 === null) {
+					$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 (! empty($includes_for_this_model) && ! in_array('*', $includes_for_this_model, true)) {
+			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 $array
+	 * @return array
+	 */
+	private function removeModelNamesFromArray(array $array): array
+	{
+		return array_diff($array, 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 bool            $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
+	 *                                          did, let's know about it ASAP, so let the exception bubble up)
+	 * @throws EE_Error
+	 */
+	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
+	 */
+	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);
+		}
+		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 InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ModelConfigurationException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws RestPasswordIncorrectException
+	 * @throws RestPasswordRequiredException
+	 * @throws UnexpectedEntityException
+	 * @throws DomainException
+	 */
+	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|null $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, true)) {
+			return $context;
+		}
+		return EEM_Base::caps_read;
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param string $default_where_conditions
+	 * @return string
+	 */
+	public function validateDefaultQueryParams(string $default_where_conditions): 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_where_conditions) {
+			$default_where_conditions = EEM_Base::default_where_conditions_all;
+		}
+		if (
+			in_array(
+				$default_where_conditions,
+				$valid_default_where_conditions_for_api_calls,
+				true
+			)
+		) {
+			return $default_where_conditions;
+		}
+		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 InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 * @throws DomainException
+	 * @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_query_params['caps'] === EEM_Base::caps_read
+			&& empty($query_params['password'])
+			&& ! $model->hasPassword()
+			&& $model->restrictedByRelatedModelPassword()
+		) {
+			$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 $model
+	 * @param $query_params
+	 * @return array
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $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 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(string $include_string, string $model_name = null): 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
+			);
+		}
+		// 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(
+					__('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]
+			);
+		}
+		// it's not you. It just doesn't exist
+		throw new RestException(
+			sprintf('rest_%s_invalid_id', $lowercase_model_name),
+			sprintf(__('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();
+				}
+			}
+		}
+	}
 }

core/services/helpers/datetime/AbstractHelper.php

Spacing +10 added lines, -10 removed lines

@@ -49,7 +49,7 @@ 
             new DateTimeZone($timezone_string);
         } catch (Exception $e) {
             // sometimes we take exception to exceptions
-            if (! $throw_error) {
+            if ( ! $throw_error) {
                 return false;
             }
             throw new EE_Error(
@@ -101,7 +101,7 @@ 
     public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
     {
         $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
+        if ( ! isset($transition['offset'])) {
             throw new DomainException(
                 sprintf(
                     esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
@@ -123,7 +123,7 @@ 
     public function timezoneSelectInput($timezone_string = '')
     {
         // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+        $datetime_format = get_option('date_format').' '.get_option('time_format');
         // if passed a value, then use that, else get WP option
         $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
         // check if the timezone is valid but don't throw any errors if it isn't
@@ -137,9 +137,9 @@ 
             $timezone_string = 'UTC';
             $check_zone_info = false;
             if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
+                $timezone_string = 'UTC+'.$gmt_offset;
             } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
+                $timezone_string = 'UTC'.$gmt_offset;
             }
         }
         ?>
@@ -159,14 +159,14 @@ 
                 esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
                 '<abbr title="Coordinated Universal Time">',
                 '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
+                '<code>'.date_i18n($datetime_format, false, true).'</code>'
             );
             ?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+        if ( ! empty($timezone_string) || ! empty($gmt_offset)) : ?>
         <br/>
         <span><?php
-        printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>');
+        printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>'.date_i18n($datetime_format).'</code>');
         ?></span>
             <?php
         endif; ?>
@@ -207,7 +207,7 @@ 
                     // transition time from date_i18n().
                     printf(
                         $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+                        '<code >'.date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])).'</code >'
                     );
                 } else {
                     esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
@@ -240,7 +240,7 @@ 
         $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
         $timezone_string = $this->getValidTimezoneString($timezone_string);
         $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+        $DateTime        = new DateTime('@'.$unix_timestamp, $TimeZone);
         $offset          = timezone_offset_get($TimeZone, $DateTime);
         return (int) $DateTime->format('U') + (int) $offset;
     }

Indentation +247 added lines, -247 removed lines

@@ -11,136 +11,136 @@ 
 
 abstract class AbstractHelper implements HelperInterface
 {
-    /**
-     * Ensures that a valid timezone string is returned.
-     *
-     * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
-     *                                 settings (or derive from set UTC offset).
-     * @return string
-     * @throws EE_Error
-     */
-    public function getValidTimezoneString($timezone_string = '')
-    {
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        $timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : $this->getTimezoneStringFromGmtOffset();
-        $this->validateTimezone($timezone_string);
-        return $timezone_string;
-    }
+	/**
+	 * Ensures that a valid timezone string is returned.
+	 *
+	 * @param string $timezone_string  When not provided then attempt to use the timezone_string set in the WP Time
+	 *                                 settings (or derive from set UTC offset).
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function getValidTimezoneString($timezone_string = '')
+	{
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		$timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: $this->getTimezoneStringFromGmtOffset();
+		$this->validateTimezone($timezone_string);
+		return $timezone_string;
+	}
 
 
 
-    /**
-     * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
-     *
-     * @param string $timezone_string
-     * @param bool   $throw_error
-     * @return bool
-     * @throws EE_Error
-     */
-    public function validateTimezone($timezone_string, $throw_error = true)
-    {
-        // easiest way to test a timezone string is just see if it throws an error when you try to create a
-        // DateTimeZone object with it
-        try {
-            new DateTimeZone($timezone_string);
-        } catch (Exception $e) {
-            // sometimes we take exception to exceptions
-            if (! $throw_error) {
-                return false;
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
-                        'event_espresso'
-                    ),
-                    $timezone_string,
-                    '<a href="http://www.php.net/manual/en/timezones.php">',
-                    '</a>'
-                )
-            );
-        }
-        return true;
-    }
+	/**
+	 * The only purpose for this static method is to validate that the incoming timezone is a valid php timezone.
+	 *
+	 * @param string $timezone_string
+	 * @param bool   $throw_error
+	 * @return bool
+	 * @throws EE_Error
+	 */
+	public function validateTimezone($timezone_string, $throw_error = true)
+	{
+		// easiest way to test a timezone string is just see if it throws an error when you try to create a
+		// DateTimeZone object with it
+		try {
+			new DateTimeZone($timezone_string);
+		} catch (Exception $e) {
+			// sometimes we take exception to exceptions
+			if (! $throw_error) {
+				return false;
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The timezone given (%1$s), is invalid, please check with %2$sthis list%3$s for what valid timezones can be used',
+						'event_espresso'
+					),
+					$timezone_string,
+					'<a href="http://www.php.net/manual/en/timezones.php">',
+					'</a>'
+				)
+			);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the site's GMT offset based on either the timezone string
-     * (in which case the gmt offset will vary depending on the location's
-     * observance of daylight savings time) or the gmt_offset wp option
-     *
-     * @return int  seconds offset
-     */
-    public function getSiteTimezoneGmtOffset()
-    {
-        $timezone_string = (string) get_option('timezone_string');
-        if ($timezone_string) {
-            try {
-                $timezone = new DateTimeZone($timezone_string);
-                return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
-            } catch (Exception $e) {
-            }
-        }
-        $offset = get_option('gmt_offset');
-        return (int) ($offset * HOUR_IN_SECONDS);
-    }
+	/**
+	 * Gets the site's GMT offset based on either the timezone string
+	 * (in which case the gmt offset will vary depending on the location's
+	 * observance of daylight savings time) or the gmt_offset wp option
+	 *
+	 * @return int  seconds offset
+	 */
+	public function getSiteTimezoneGmtOffset()
+	{
+		$timezone_string = (string) get_option('timezone_string');
+		if ($timezone_string) {
+			try {
+				$timezone = new DateTimeZone($timezone_string);
+				return $timezone->getOffset(new DateTime()); // in WordPress DateTime defaults to UTC
+			} catch (Exception $e) {
+			}
+		}
+		$offset = get_option('gmt_offset');
+		return (int) ($offset * HOUR_IN_SECONDS);
+	}
 
 
-    /**
-     * Get Timezone offset for given timezone object
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param null|int     $time
-     * @return int
-     * @throws DomainException
-     */
-    public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
-    {
-        $transition = $this->getTimezoneTransitions($date_time_zone, $time);
-        if (! isset($transition['offset'])) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
-                    print_r($transition, true)
-                )
-            );
-        }
-        return $transition['offset'];
-    }
+	/**
+	 * Get Timezone offset for given timezone object
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param null|int     $time
+	 * @return int
+	 * @throws DomainException
+	 */
+	public function getTimezoneOffset(DateTimeZone $date_time_zone, $time = null)
+	{
+		$transition = $this->getTimezoneTransitions($date_time_zone, $time);
+		if (! isset($transition['offset'])) {
+			throw new DomainException(
+				sprintf(
+					esc_html__('An invalid timezone transition was received %1$s', 'event_espresso'),
+					print_r($transition, true)
+				)
+			);
+		}
+		return $transition['offset'];
+	}
 
 
-    /**
-     * Provide a timezone select input
-     *
-     * @param string $timezone_string
-     * @return string
-     * @throws EE_Error
-     */
-    public function timezoneSelectInput($timezone_string = '')
-    {
-        // get WP date time format
-        $datetime_format = get_option('date_format') . ' ' . get_option('time_format');
-        // if passed a value, then use that, else get WP option
-        $timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
-        // check if the timezone is valid but don't throw any errors if it isn't
-        $timezone_string = $this->validateTimezone($timezone_string, false)
-            ? $timezone_string
-            : '';
-        $gmt_offset      = get_option('gmt_offset');
-        $check_zone_info = true;
-        if (empty($timezone_string)) {
-            // Create a UTC+- zone if no timezone string exists
-            $timezone_string = 'UTC';
-            $check_zone_info = false;
-            if ($gmt_offset > 0) {
-                $timezone_string = 'UTC+' . $gmt_offset;
-            } elseif ($gmt_offset < 0) {
-                $timezone_string = 'UTC' . $gmt_offset;
-            }
-        }
-        ?>
+	/**
+	 * Provide a timezone select input
+	 *
+	 * @param string $timezone_string
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function timezoneSelectInput($timezone_string = '')
+	{
+		// get WP date time format
+		$datetime_format = get_option('date_format') . ' ' . get_option('time_format');
+		// if passed a value, then use that, else get WP option
+		$timezone_string = ! empty($timezone_string) ? $timezone_string : (string) get_option('timezone_string');
+		// check if the timezone is valid but don't throw any errors if it isn't
+		$timezone_string = $this->validateTimezone($timezone_string, false)
+			? $timezone_string
+			: '';
+		$gmt_offset      = get_option('gmt_offset');
+		$check_zone_info = true;
+		if (empty($timezone_string)) {
+			// Create a UTC+- zone if no timezone string exists
+			$timezone_string = 'UTC';
+			$check_zone_info = false;
+			if ($gmt_offset > 0) {
+				$timezone_string = 'UTC+' . $gmt_offset;
+			} elseif ($gmt_offset < 0) {
+				$timezone_string = 'UTC' . $gmt_offset;
+			}
+		}
+		?>
         <p>
             <label for="timezone_string"><?php esc_html_e('timezone', 'event_espresso'); ?></label>
             <select id="timezone_string" name="timezone_string">
@@ -153,153 +153,153 @@ 
         <p>
         <span>
             <?php
-            printf(
-                esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
-                '<abbr title="Coordinated Universal Time">',
-                '</abbr>',
-                '<code>' . date_i18n($datetime_format, false, true) . '</code>'
-            );
-            ?></span>
+			printf(
+				esc_html__('%1$sUTC%2$s time is %3$s', 'event_espresso'),
+				'<abbr title="Coordinated Universal Time">',
+				'</abbr>',
+				'<code>' . date_i18n($datetime_format, false, true) . '</code>'
+			);
+			?></span>
         <?php
-        if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
+		if (! empty($timezone_string) || ! empty($gmt_offset)) : ?>
         <br/>
         <span><?php
-        printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>');
-        ?></span>
+		printf(esc_html__('Local time is %1$s', 'event_espresso'), '<code>' . date_i18n($datetime_format) . '</code>');
+		?></span>
             <?php
-        endif; ?>
+		endif; ?>
 
         <?php
-        if ($check_zone_info && $timezone_string) : ?>
+		if ($check_zone_info && $timezone_string) : ?>
         <br/>
         <span>
                 <?php
-                // Set TZ so localtime works.
-                date_default_timezone_set($timezone_string);
-                $now = localtime(time(), true);
-                if ($now['tm_isdst']) {
-                    esc_html_e('This timezone is currently in daylight saving time.', 'event_espresso');
-                } else {
-                    esc_html_e('This timezone is currently in standard time.', 'event_espresso');
-                }
-                ?>
+				// Set TZ so localtime works.
+				date_default_timezone_set($timezone_string);
+				$now = localtime(time(), true);
+				if ($now['tm_isdst']) {
+					esc_html_e('This timezone is currently in daylight saving time.', 'event_espresso');
+				} else {
+					esc_html_e('This timezone is currently in standard time.', 'event_espresso');
+				}
+				?>
             <br/>
             <?php
-            if (function_exists('timezone_transitions_get')) {
-                $found                   = false;
-                $date_time_zone_selected = new DateTimeZone($timezone_string);
-                $tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
-                $right_now               = time();
-                $tr['isdst']             = false;
-                foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
-                    if ($tr['ts'] > $right_now) {
-                        $found = true;
-                        break;
-                    }
-                }
-                if ($found) {
-                    $message = $tr['isdst']
-                        ? esc_html__(' Daylight saving time begins on: %s.', 'event_espresso')
-                        : esc_html__(' Standard time begins  on: %s.', 'event_espresso');
-                    // Add the difference between the current offset and the new offset to ts to get the correct
-                    // transition time from date_i18n().
-                    printf(
-                        $message,
-                        '<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
-                    );
-                } else {
-                    esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
-                }
-            }
-            // Set back to UTC.
-            date_default_timezone_set('UTC');
-            ?>
+			if (function_exists('timezone_transitions_get')) {
+				$found                   = false;
+				$date_time_zone_selected = new DateTimeZone($timezone_string);
+				$tz_offset               = timezone_offset_get($date_time_zone_selected, date_create());
+				$right_now               = time();
+				$tr['isdst']             = false;
+				foreach (timezone_transitions_get($date_time_zone_selected) as $tr) {
+					if ($tr['ts'] > $right_now) {
+						$found = true;
+						break;
+					}
+				}
+				if ($found) {
+					$message = $tr['isdst']
+						? esc_html__(' Daylight saving time begins on: %s.', 'event_espresso')
+						: esc_html__(' Standard time begins  on: %s.', 'event_espresso');
+					// Add the difference between the current offset and the new offset to ts to get the correct
+					// transition time from date_i18n().
+					printf(
+						$message,
+						'<code >' . date_i18n($datetime_format, $tr['ts'] + ($tz_offset - $tr['offset'])) . '</code >'
+					);
+				} else {
+					esc_html_e('This timezone does not observe daylight saving time.', 'event_espresso');
+				}
+			}
+			// Set back to UTC.
+			date_default_timezone_set('UTC');
+			?>
         </span></p>
             <?php
-        endif;
-    }
+		endif;
+	}
 
 
-    /**
-     * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
-     * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
-     * the site is used.
-     * This is used typically when using a Unix timestamp any core WP functions that expect their specially
-     * computed timestamp (i.e. date_i18n() )
-     *
-     * @param int    $unix_timestamp  if 0, then time() will be used.
-     * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
-     *                                site will be used.
-     * @return int      unix_timestamp value with the offset applied for the given timezone.
-     * @throws EE_Error
-     */
-    public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
-    {
-        $unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
-        $timezone_string = $this->getValidTimezoneString($timezone_string);
-        $TimeZone        = new DateTimeZone($timezone_string);
-        $DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
-        $offset          = timezone_offset_get($TimeZone, $DateTime);
-        return (int) $DateTime->format('U') + (int) $offset;
-    }
+	/**
+	 * This method will take an incoming unix timestamp and add the offset to it for the given timezone_string.
+	 * If no unix timestamp is given then time() is used.  If no timezone is given then the set timezone string for
+	 * the site is used.
+	 * This is used typically when using a Unix timestamp any core WP functions that expect their specially
+	 * computed timestamp (i.e. date_i18n() )
+	 *
+	 * @param int    $unix_timestamp  if 0, then time() will be used.
+	 * @param string $timezone_string timezone_string. If empty, then the current set timezone for the
+	 *                                site will be used.
+	 * @return int      unix_timestamp value with the offset applied for the given timezone.
+	 * @throws EE_Error
+	 */
+	public function getTimestampWithOffset($unix_timestamp = 0, $timezone_string = '')
+	{
+		$unix_timestamp  = $unix_timestamp === 0 ? time() : (int) $unix_timestamp;
+		$timezone_string = $this->getValidTimezoneString($timezone_string);
+		$TimeZone        = new DateTimeZone($timezone_string);
+		$DateTime        = new DateTime('@' . $unix_timestamp, $TimeZone);
+		$offset          = timezone_offset_get($TimeZone, $DateTime);
+		return (int) $DateTime->format('U') + (int) $offset;
+	}
 
 
-    /**
-     * Get Timezone Transitions
-     *
-     * @param DateTimeZone $date_time_zone
-     * @param int|null     $time
-     * @param bool         $first_only
-     * @return array|mixed
-     */
-    public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
-    {
-        $time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
-        $time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
-        $transitions = $date_time_zone->getTransitions($time);
-        return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
-    }
+	/**
+	 * Get Timezone Transitions
+	 *
+	 * @param DateTimeZone $date_time_zone
+	 * @param int|null     $time
+	 * @param bool         $first_only
+	 * @return array|mixed
+	 */
+	public function getTimezoneTransitions(DateTimeZone $date_time_zone, $time = null, $first_only = true)
+	{
+		$time        = is_int($time) || $time === null ? $time : (int) strtotime($time);
+		$time        = preg_match(EE_Datetime_Field::unix_timestamp_regex, $time) ? $time : time();
+		$transitions = $date_time_zone->getTransitions($time);
+		return $first_only && ! isset($transitions['ts']) ? reset($transitions) : $transitions;
+	}
 
 
 
-    /**
-     * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
-     *
-     * @param int $gmt_offset
-     * @return int
-     */
-    public function adjustInvalidGmtOffsets($gmt_offset = 0)
-    {
-        return $gmt_offset;
-    }
+	/**
+	 * Default to just returning the provided $gmt_offset.  Children can override if adjustment needed.
+	 *
+	 * @param int $gmt_offset
+	 * @return int
+	 */
+	public function adjustInvalidGmtOffsets($gmt_offset = 0)
+	{
+		return $gmt_offset;
+	}
 
 
 
-    /**
-     * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
-     * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
-     * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
-     * offset.
-     * @param  float|string $gmt_offset
-     * @return float|string
-     */
-    protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
-    {
-        // if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
-        // set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
-        // that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
-        if ($gmt_offset === '') {
-            // autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
-            if (get_option('timezone_string')) {
-                return (string) get_option('timezone_string');
-            }
-        }
-        $gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
-        $gmt_offset = (float) $gmt_offset;
-        // if $gmt_offset is 0 or is still an empty string, then just return UTC
-        if ($gmt_offset === (float) 0) {
-            return 'UTC';
-        }
-        return $gmt_offset;
-    }
+	/**
+	 * This receives an incoming gmt_offset and santizes it.  If the provide value is an empty string, then this will
+	 * attempt to get the offset from the timezone string.  If this returns a string, then a timezone string was
+	 * successfully derived from existing timezone_string in the db.  If not, then a float is returned for the provided
+	 * offset.
+	 * @param  float|string $gmt_offset
+	 * @return float|string
+	 */
+	protected function sanitizeInitialIncomingGmtOffsetForGettingTimezoneString($gmt_offset)
+	{
+		// if there is no incoming gmt_offset, then because WP hooks in on timezone_string, we need to see if that is
+		// set because it will override `gmt_offset` via `pre_get_option` filter.  If that's set, then let's just use
+		// that!  Otherwise we'll leave timezone_string at the default of 'UTC' before doing other logic.
+		if ($gmt_offset === '') {
+			// autoloaded so no need to set to a variable.  There will not be multiple hits to the db.
+			if (get_option('timezone_string')) {
+				return (string) get_option('timezone_string');
+			}
+		}
+		$gmt_offset = $gmt_offset !== '' ? $gmt_offset : (string) get_option('gmt_offset');
+		$gmt_offset = (float) $gmt_offset;
+		// if $gmt_offset is 0 or is still an empty string, then just return UTC
+		if ($gmt_offset === (float) 0) {
+			return 'UTC';
+		}
+		return $gmt_offset;
+	}
 }

core/services/loaders/LoaderInterface.php

Indentation +44 added lines, -44 removed lines

@@ -8,58 +8,58 @@
 interface LoaderInterface
 {
 
-    /**
-     * Can be for instantiating a new instance of a class,
-     * or for getting a shared instance of a class (default)
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @param bool                      $shared
-     * @return mixed
-     */
-    public function load($fqcn, array $arguments = [], $shared = true);
+	/**
+	 * Can be for instantiating a new instance of a class,
+	 * or for getting a shared instance of a class (default)
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @param bool                      $shared
+	 * @return mixed
+	 */
+	public function load($fqcn, array $arguments = [], $shared = true);
 
 
-    /**
-     * Used for instantiating a new instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getNew($fqcn, array $arguments = []);
+	/**
+	 * Used for instantiating a new instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getNew($fqcn, array $arguments = []);
 
 
-    /**
-     * Used for getting a shared instance of a class
-     *
-     * @param FullyQualifiedName|string $fqcn
-     * @param array                     $arguments
-     * @return mixed
-     */
-    public function getShared($fqcn, array $arguments = []);
+	/**
+	 * Used for getting a shared instance of a class
+	 *
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param array                     $arguments
+	 * @return mixed
+	 */
+	public function getShared($fqcn, array $arguments = []);
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @param mixed                     $object
-     * @param array                     $arguments
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function share($fqcn, $object, array $arguments = []);
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @param mixed                     $object
+	 * @param array                     $arguments
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function share($fqcn, $object, array $arguments = []);
 
 
-    /**
-     * @param FullyQualifiedName|string $fqcn
-     * @return bool
-     * @throws InvalidArgumentException
-     */
-    public function remove($fqcn);
+	/**
+	 * @param FullyQualifiedName|string $fqcn
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 */
+	public function remove($fqcn);
 
 
-    /**
-     * calls reset() on loader if method exists
-     */
-    public function reset();
+	/**
+	 * calls reset() on loader if method exists
+	 */
+	public function reset();
 }

core/domain/services/registration/form/v1/RegFormDependencyHandler.php

Indentation +58 added lines, -58 removed lines

@@ -7,62 +7,62 @@
 
 class RegFormDependencyHandler extends DependencyHandler
 {
-    /**
-     * @return void
-     */
-    public function registerDependencies()
-    {
-        $reg_form_dependencies = [
-            'EventEspresso\core\domain\services\registration\form\v1\RegForm'                => [
-                null,
-                'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegistrantForm'         => [
-                null,
-                null,
-                null,
-                null,
-                null,
-                'EEM_Event_Question_Group' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => [
-                null,
-                'EEM_Answer' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionGroup'   => [
-                null,
-                null,
-                null,
-                'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\CountryOptions'         => [
-                null,
-                'EEM_Answer'  => EE_Dependency_Map::load_from_cache,
-                'EEM_Country' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\StateOptions'           => [
-                null,
-                'EEM_State' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormHandler'         => [
-                null,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData'         => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => EE_Dependency_Map::load_from_cache,
-                'EE_Registration_Processor'                                                      => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormInputHandler'    => [
-                null,
-                null,
-                'EEM_Attendee'                                                           => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
-            ],
-            'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => [
-                'EventEspresso\core\services\commands\CommandBus'                        => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
-            ],
-        ];
-        foreach ($reg_form_dependencies as $class => $dependencies) {
-            $this->dependency_map->registerDependencies($class, $dependencies);
-        }
-    }
+	/**
+	 * @return void
+	 */
+	public function registerDependencies()
+	{
+		$reg_form_dependencies = [
+			'EventEspresso\core\domain\services\registration\form\v1\RegForm'                => [
+				null,
+				'EE_Registration_Config' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegistrantForm'         => [
+				null,
+				null,
+				null,
+				null,
+				null,
+				'EEM_Event_Question_Group' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => [
+				null,
+				'EEM_Answer' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionGroup'   => [
+				null,
+				null,
+				null,
+				'EventEspresso\core\domain\services\registration\form\v1\RegFormQuestionFactory' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\CountryOptions'         => [
+				null,
+				'EEM_Answer'  => EE_Dependency_Map::load_from_cache,
+				'EEM_Country' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\StateOptions'           => [
+				null,
+				'EEM_State' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormHandler'         => [
+				null,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData'         => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => EE_Dependency_Map::load_from_cache,
+				'EE_Registration_Processor'                                                      => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormInputHandler'    => [
+				null,
+				null,
+				'EEM_Attendee'                                                           => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
+			],
+			'EventEspresso\core\domain\services\registration\form\v1\RegFormAttendeeFactory' => [
+				'EventEspresso\core\services\commands\CommandBus'                        => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\domain\services\registration\form\v1\RegistrantData' => EE_Dependency_Map::load_from_cache,
+			],
+		];
+		foreach ($reg_form_dependencies as $class => $dependencies) {
+			$this->dependency_map->registerDependencies($class, $dependencies);
+		}
+	}
 }

core/domain/services/registration/form/v1/RegFormHandler.php

Indentation +279 added lines, -279 removed lines

@@ -18,310 +18,310 @@
 class RegFormHandler
 {
 
-    /**
-     * @var EE_Checkout
-     */
-    public $checkout;
+	/**
+	 * @var EE_Checkout
+	 */
+	public $checkout;
 
-    /**
-     * @var RegFormInputHandler
-     */
-    public $input_handler;
+	/**
+	 * @var RegFormInputHandler
+	 */
+	public $input_handler;
 
-    /**
-     * @var array
-     */
-    private $non_input_form_sections;
+	/**
+	 * @var array
+	 */
+	private $non_input_form_sections;
 
-    /**
-     * @var RegFormAttendeeFactory
-     */
-    private $attendee_factory;
+	/**
+	 * @var RegFormAttendeeFactory
+	 */
+	private $attendee_factory;
 
-    /**
-     * @var RegistrantData
-     */
-    private $registrant_data;
+	/**
+	 * @var RegistrantData
+	 */
+	private $registrant_data;
 
-    /**
-     * @var EE_Registration_Processor
-     */
-    private $registration_processor;
+	/**
+	 * @var EE_Registration_Processor
+	 */
+	private $registration_processor;
 
-    /**
-     * @var bool
-     */
-    private $valid;
+	/**
+	 * @var bool
+	 */
+	private $valid;
 
 
-    /**
-     * RegFormHandler constructor.
-     */
-    public function __construct(
-        EE_Checkout $checkout,
-        RegistrantData $registrant_data,
-        RegFormAttendeeFactory $attendee_factory,
-        EE_Registration_Processor $registration_processor
-    ) {
-        $this->checkout                = $checkout;
-        $this->registrant_data         = $registrant_data;
-        $this->attendee_factory        = $attendee_factory;
-        $this->registration_processor  = $registration_processor;
-        // reg form sections that do not contain inputs
-        $this->non_input_form_sections = [
-            'primary_registrant',
-            'additional_attendee_reg_info',
-            'spco_copy_attendee_chk',
-        ];
-        $this->initializeInputHandler();
-    }
+	/**
+	 * RegFormHandler constructor.
+	 */
+	public function __construct(
+		EE_Checkout $checkout,
+		RegistrantData $registrant_data,
+		RegFormAttendeeFactory $attendee_factory,
+		EE_Registration_Processor $registration_processor
+	) {
+		$this->checkout                = $checkout;
+		$this->registrant_data         = $registrant_data;
+		$this->attendee_factory        = $attendee_factory;
+		$this->registration_processor  = $registration_processor;
+		// reg form sections that do not contain inputs
+		$this->non_input_form_sections = [
+			'primary_registrant',
+			'additional_attendee_reg_info',
+			'spco_copy_attendee_chk',
+		];
+		$this->initializeInputHandler();
+	}
 
 
-    private function initializeInputHandler()
-    {
-        $reg_form = $this->checkout->current_step->reg_form;
-        $required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
-        $this->input_handler = LoaderFactory::getShared(
-            RegFormInputHandler::class,
-            [ $this->checkout->reg_url_link, $required_questions ]
-        );
-    }
+	private function initializeInputHandler()
+	{
+		$reg_form = $this->checkout->current_step->reg_form;
+		$required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
+		$this->input_handler = LoaderFactory::getShared(
+			RegFormInputHandler::class,
+			[ $this->checkout->reg_url_link, $required_questions ]
+		);
+	}
 
 
-    /**
-     * @return int
-     */
-    public function attendeeCount(): int
-    {
-        return $this->registrant_data->attendeeCount();
-    }
+	/**
+	 * @return int
+	 */
+	public function attendeeCount(): int
+	{
+		return $this->registrant_data->attendeeCount();
+	}
 
 
-    /**
-     * @return bool
-     */
-    private function isInvalid(): bool
-    {
-        $this->valid = false;
-        return $this->valid;
-    }
+	/**
+	 * @return bool
+	 */
+	private function isInvalid(): bool
+	{
+		$this->valid = false;
+		return $this->valid;
+	}
 
 
-    /**
-     * @param EE_Registration[] $registrations
-     * @param array[][]         $reg_form_data
-     * @return bool
-     * @throws EntityNotFoundException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws RuntimeException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function processRegistrations(array $registrations, array $reg_form_data): bool
-    {
-        // start off optimistic, then trip this to false if anything goes wrong
-        $this->valid = true;
-        foreach ($registrations as $registration) {
-            // verify EE_Registration object
-            if (! $this->isValidRegistration($registration)) {
-                return $this->isInvalid();
-            }
-            $reg_url_link = $registration->reg_url_link();
-            // reg_url_link exists ?
-            if (! $this->isValidRegUrlLink($reg_url_link)) {
-                return $this->isInvalid();
-            }
-            // should this registration be processed during this visit ?
-            if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
-                continue;
-            }
-            // if NOT revisiting, then let's save the registration now,
-            // so that we have a REG_ID to use when generating other objects
-            if (! $this->checkout->revisit) {
-                $registration->save();
-            }
-            /**
-             * This allows plugins to trigger a fail on processing of a
-             * registration for any conditions they may have for it to pass.
-             *
-             * @var bool if true is returned by the plugin then the registration processing is halted.
-             */
-            if (
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
-                    false,
-                    $this->registrant_data->attendeeCount(),
-                    $registration,
-                    $registrations,
-                    $reg_form_data,
-                    $this
-                )
-            ) {
-                return $this->isInvalid();
-            }
+	/**
+	 * @param EE_Registration[] $registrations
+	 * @param array[][]         $reg_form_data
+	 * @return bool
+	 * @throws EntityNotFoundException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws RuntimeException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function processRegistrations(array $registrations, array $reg_form_data): bool
+	{
+		// start off optimistic, then trip this to false if anything goes wrong
+		$this->valid = true;
+		foreach ($registrations as $registration) {
+			// verify EE_Registration object
+			if (! $this->isValidRegistration($registration)) {
+				return $this->isInvalid();
+			}
+			$reg_url_link = $registration->reg_url_link();
+			// reg_url_link exists ?
+			if (! $this->isValidRegUrlLink($reg_url_link)) {
+				return $this->isInvalid();
+			}
+			// should this registration be processed during this visit ?
+			if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
+				continue;
+			}
+			// if NOT revisiting, then let's save the registration now,
+			// so that we have a REG_ID to use when generating other objects
+			if (! $this->checkout->revisit) {
+				$registration->save();
+			}
+			/**
+			 * This allows plugins to trigger a fail on processing of a
+			 * registration for any conditions they may have for it to pass.
+			 *
+			 * @var bool if true is returned by the plugin then the registration processing is halted.
+			 */
+			if (
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegistrations__bypass',
+					false,
+					$this->registrant_data->attendeeCount(),
+					$registration,
+					$registrations,
+					$reg_form_data,
+					$this
+				)
+			) {
+				return $this->isInvalid();
+			}
 
-            // Houston, we have a registration!
-            if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
-                return $this->isInvalid();
-            }
-        }
-        return $this->valid;
-    }
+			// Houston, we have a registration!
+			if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
+				return $this->isInvalid();
+			}
+		}
+		return $this->valid;
+	}
 
 
-    /**
-     * @param string $reg_url_link
-     * @return bool
-     */
-    private function isValidRegUrlLink(string $reg_url_link): bool
-    {
-        if (! empty($reg_url_link)) {
-            return true;
-        }
-        EE_Error::add_error(
-            esc_html__(
-                'An invalid or missing line item ID was encountered while attempting to process the registration form.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
+	/**
+	 * @param string $reg_url_link
+	 * @return bool
+	 */
+	private function isValidRegUrlLink(string $reg_url_link): bool
+	{
+		if (! empty($reg_url_link)) {
+			return true;
+		}
+		EE_Error::add_error(
+			esc_html__(
+				'An invalid or missing line item ID was encountered while attempting to process the registration form.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
 
 
-    /**
-     * @param EE_Registration|null $registration
-     * @return bool
-     */
-    private function isValidRegistration(?EE_Registration $registration): bool
-    {
-        // verify EE_Registration object
-        if ($registration instanceof EE_Registration) {
-            return true;
-        }
-        EE_Error::add_error(
-            esc_html__(
-                'An invalid Registration object was discovered when attempting to process your registration information.',
-                'event_espresso'
-            ),
-            __FILE__,
-            __FUNCTION__,
-            __LINE__
-        );
-        return false;
-    }
+	/**
+	 * @param EE_Registration|null $registration
+	 * @return bool
+	 */
+	private function isValidRegistration(?EE_Registration $registration): bool
+	{
+		// verify EE_Registration object
+		if ($registration instanceof EE_Registration) {
+			return true;
+		}
+		EE_Error::add_error(
+			esc_html__(
+				'An invalid Registration object was discovered when attempting to process your registration information.',
+				'event_espresso'
+			),
+			__FILE__,
+			__FUNCTION__,
+			__LINE__
+		);
+		return false;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @param string          $reg_url_link
-     * @param array[][]       $reg_form_data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegistration(
-        EE_Registration $registration,
-        string $reg_url_link,
-        array $reg_form_data
-    ): bool {
-        $this->registrant_data->initializeRegistrantData($registration);
-        if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
-            return false;
-        }
-        // RegFormAttendeeFactory
-        if (! $this->attendee_factory->create($registration, $reg_url_link)) {
-            return false;
-        }
-        // at this point, we should have enough details about the registrant to consider the registration
-        // NOT incomplete
-        $this->registration_processor->toggle_incomplete_registration_status_to_default(
-            $registration,
-            false,
-            new Context(
-                'spco_reg_step_attendee_information_process_registrations',
-                esc_html__(
-                    'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
-                    'event_espresso'
-                )
-            )
-        );
-        // we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
-        // abandoned
-        $this->checkout->transaction->toggle_failed_transaction_status();
-        // if we've gotten this far, then let's save what we have
-        $registration->save();
-        // add relation between TXN and registration
-        $this->associateRegistrationWithTransaction($registration);
-        return true;
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $reg_url_link
+	 * @param array[][]       $reg_form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegistration(
+		EE_Registration $registration,
+		string $reg_url_link,
+		array $reg_form_data
+	): bool {
+		$this->registrant_data->initializeRegistrantData($registration);
+		if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
+			return false;
+		}
+		// RegFormAttendeeFactory
+		if (! $this->attendee_factory->create($registration, $reg_url_link)) {
+			return false;
+		}
+		// at this point, we should have enough details about the registrant to consider the registration
+		// NOT incomplete
+		$this->registration_processor->toggle_incomplete_registration_status_to_default(
+			$registration,
+			false,
+			new Context(
+				'spco_reg_step_attendee_information_process_registrations',
+				esc_html__(
+					'Finished populating registration with details from the registration form after submitting the Attendee Information Reg Step.',
+					'event_espresso'
+				)
+			)
+		);
+		// we can also consider the TXN to not have been failed, so temporarily upgrade it's status to
+		// abandoned
+		$this->checkout->transaction->toggle_failed_transaction_status();
+		// if we've gotten this far, then let's save what we have
+		$registration->save();
+		// add relation between TXN and registration
+		$this->associateRegistrationWithTransaction($registration);
+		return true;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @param string          $reg_url_link
-     * @param array           $reg_form_data
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
-    {
-        if (isset($reg_form_data[ $reg_url_link ])) {
-            // do we need to copy basic info from primary attendee ?
-            $copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
-            $this->registrant_data->setCopyPrimary($copy_primary);
-            // filter form input data for this registration
-            $reg_form_data[ $reg_url_link ] = (array) apply_filters(
-                'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-                $reg_form_data[ $reg_url_link ],
-                $registration
-            );
-            if (isset($reg_form_data['primary_attendee'])) {
-                $primary_reg_url_link = $reg_form_data['primary_attendee'] ?? '';
-                $this->registrant_data->addPrimaryRegistrantDataValue('reg_url_link', $primary_reg_url_link);
-                unset($reg_form_data['primary_attendee']);
-            }
-            // now loop through our array of valid post data && process attendee reg forms
-            foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
-                if (in_array($form_section, $this->non_input_form_sections, true)) {
-                    continue;
-                }
-                foreach ($form_inputs as $form_input => $input_value) {
-                    $input_processed = $this->input_handler->processFormInput(
-                        $registration,
-                        $reg_url_link,
-                        $form_input,
-                        $input_value
-                    );
-                    if (! $input_processed) {
-                        return false;
-                    }
-                }
-            }
-        }
-        return true;
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @param string          $reg_url_link
+	 * @param array           $reg_form_data
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
+	{
+		if (isset($reg_form_data[ $reg_url_link ])) {
+			// do we need to copy basic info from primary attendee ?
+			$copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
+								  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+			$this->registrant_data->setCopyPrimary($copy_primary);
+			// filter form input data for this registration
+			$reg_form_data[ $reg_url_link ] = (array) apply_filters(
+				'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
+				$reg_form_data[ $reg_url_link ],
+				$registration
+			);
+			if (isset($reg_form_data['primary_attendee'])) {
+				$primary_reg_url_link = $reg_form_data['primary_attendee'] ?? '';
+				$this->registrant_data->addPrimaryRegistrantDataValue('reg_url_link', $primary_reg_url_link);
+				unset($reg_form_data['primary_attendee']);
+			}
+			// now loop through our array of valid post data && process attendee reg forms
+			foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
+				if (in_array($form_section, $this->non_input_form_sections, true)) {
+					continue;
+				}
+				foreach ($form_inputs as $form_input => $input_value) {
+					$input_processed = $this->input_handler->processFormInput(
+						$registration,
+						$reg_url_link,
+						$form_input,
+						$input_value
+					);
+					if (! $input_processed) {
+						return false;
+					}
+				}
+			}
+		}
+		return true;
+	}
 
 
-    /**
-     * @param EE_Registration $registration
-     * @return void
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    private function associateRegistrationWithTransaction(EE_Registration $registration)
-    {
-        // add relation to registration
-        $this->checkout->transaction->_add_relation_to($registration, 'Registration');
-        $this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
-    }
+	/**
+	 * @param EE_Registration $registration
+	 * @return void
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	private function associateRegistrationWithTransaction(EE_Registration $registration)
+	{
+		// add relation to registration
+		$this->checkout->transaction->_add_relation_to($registration, 'Registration');
+		$this->checkout->transaction->update_cache_after_object_save('Registration', $registration);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -83,7 +83,7 @@ 
         $required_questions = $reg_form instanceof RegForm ? $reg_form->requiredQuestions() : [];
         $this->input_handler = LoaderFactory::getShared(
             RegFormInputHandler::class,
-            [ $this->checkout->reg_url_link, $required_questions ]
+            [$this->checkout->reg_url_link, $required_questions]
         );
     }
 
@@ -125,21 +125,21 @@ 
         $this->valid = true;
         foreach ($registrations as $registration) {
             // verify EE_Registration object
-            if (! $this->isValidRegistration($registration)) {
+            if ( ! $this->isValidRegistration($registration)) {
                 return $this->isInvalid();
             }
             $reg_url_link = $registration->reg_url_link();
             // reg_url_link exists ?
-            if (! $this->isValidRegUrlLink($reg_url_link)) {
+            if ( ! $this->isValidRegUrlLink($reg_url_link)) {
                 return $this->isInvalid();
             }
             // should this registration be processed during this visit ?
-            if (! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
+            if ( ! $this->checkout->visit_allows_processing_of_this_registration($registration)) {
                 continue;
             }
             // if NOT revisiting, then let's save the registration now,
             // so that we have a REG_ID to use when generating other objects
-            if (! $this->checkout->revisit) {
+            if ( ! $this->checkout->revisit) {
                 $registration->save();
             }
             /**
@@ -163,7 +163,7 @@ 
             }
 
             // Houston, we have a registration!
-            if (! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
+            if ( ! $this->processRegistration($registration, $reg_url_link, $reg_form_data)) {
                 return $this->isInvalid();
             }
         }
@@ -177,7 +177,7 @@ 
      */
     private function isValidRegUrlLink(string $reg_url_link): bool
     {
-        if (! empty($reg_url_link)) {
+        if ( ! empty($reg_url_link)) {
             return true;
         }
         EE_Error::add_error(
@@ -230,11 +230,11 @@ 
         array $reg_form_data
     ): bool {
         $this->registrant_data->initializeRegistrantData($registration);
-        if (! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
+        if ( ! $this->processRegFormData($registration, $reg_url_link, $reg_form_data)) {
             return false;
         }
         // RegFormAttendeeFactory
-        if (! $this->attendee_factory->create($registration, $reg_url_link)) {
+        if ( ! $this->attendee_factory->create($registration, $reg_url_link)) {
             return false;
         }
         // at this point, we should have enough details about the registrant to consider the registration
@@ -271,15 +271,15 @@ 
      */
     private function processRegFormData(EE_Registration $registration, string $reg_url_link, array $reg_form_data): bool
     {
-        if (isset($reg_form_data[ $reg_url_link ])) {
+        if (isset($reg_form_data[$reg_url_link])) {
             // do we need to copy basic info from primary attendee ?
-            $copy_primary = isset($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info'])
-                                  && absint($reg_form_data[ $reg_url_link ]['additional_attendee_reg_info']) === 0;
+            $copy_primary = isset($reg_form_data[$reg_url_link]['additional_attendee_reg_info'])
+                                  && absint($reg_form_data[$reg_url_link]['additional_attendee_reg_info']) === 0;
             $this->registrant_data->setCopyPrimary($copy_primary);
             // filter form input data for this registration
-            $reg_form_data[ $reg_url_link ] = (array) apply_filters(
+            $reg_form_data[$reg_url_link] = (array) apply_filters(
                 'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegFormHandler__processRegFormData__registrant_form_data',
-                $reg_form_data[ $reg_url_link ],
+                $reg_form_data[$reg_url_link],
                 $registration
             );
             if (isset($reg_form_data['primary_attendee'])) {
@@ -288,7 +288,7 @@ 
                 unset($reg_form_data['primary_attendee']);
             }
             // now loop through our array of valid post data && process attendee reg forms
-            foreach ($reg_form_data[ $reg_url_link ] as $form_section => $form_inputs) {
+            foreach ($reg_form_data[$reg_url_link] as $form_section => $form_inputs) {
                 if (in_array($form_section, $this->non_input_form_sections, true)) {
                     continue;
                 }
@@ -299,7 +299,7 @@ 
                         $form_input,
                         $input_value
                     );
-                    if (! $input_processed) {
+                    if ( ! $input_processed) {
                         return false;
                     }
                 }

core/domain/services/registration/form/v1/CountryOptions.php

Indentation +96 added lines, -96 removed lines

@@ -13,109 +13,109 @@
 
 class CountryOptions
 {
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
 
-    /**
-     * @var EEM_Answer
-     */
-    public $answer_model;
+	/**
+	 * @var EEM_Answer
+	 */
+	public $answer_model;
 
-    /**
-     * @var EEM_Country
-     */
-    public $country_model;
+	/**
+	 * @var EEM_Country
+	 */
+	public $country_model;
 
-    /**
-     * @var [][]
-     */
-    private $country_options = [];
+	/**
+	 * @var [][]
+	 */
+	private $country_options = [];
 
 
-    /**
-     * CountryOptions constructor.
-     *
-     * @param string      $action
-     * @param EEM_Answer  $answer_model
-     * @param EEM_Country $country_model
-     */
-    public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
-    {
-        $this->action        = $action;
-        $this->answer_model  = $answer_model;
-        $this->country_model = $country_model;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__country_options',
-            [$this, 'forLegacyFormInput'],
-            10,
-            4
-        );
-    }
+	/**
+	 * CountryOptions constructor.
+	 *
+	 * @param string      $action
+	 * @param EEM_Answer  $answer_model
+	 * @param EEM_Country $country_model
+	 */
+	public function __construct(string $action, EEM_Answer $answer_model, EEM_Country $country_model)
+	{
+		$this->action        = $action;
+		$this->answer_model  = $answer_model;
+		$this->country_model = $country_model;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__country_options',
+			[$this, 'forLegacyFormInput'],
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Gets the list of countries for the form input
-     *
-     * @param array|null           $countries_list deprecated prop from an old hook
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer deprecated prop from an old hook
-     * @return array 2d keys are country IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function forLegacyFormInput(
-        array $countries_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        if (! isset($this->country_options[ $this->action ])) {
-            $this->generateLegacyCountryOptions($question, $registration);
-        }
-        return $this->country_options[ $this->action ];
-    }
+	/**
+	 * Gets the list of countries for the form input
+	 *
+	 * @param array|null           $countries_list deprecated prop from an old hook
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer deprecated prop from an old hook
+	 * @return array 2d keys are country IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function forLegacyFormInput(
+		array $countries_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		if (! isset($this->country_options[ $this->action ])) {
+			$this->generateLegacyCountryOptions($question, $registration);
+		}
+		return $this->country_options[ $this->action ];
+	}
 
 
-    /**
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
-    {
-        // get possibly cached list of countries
-        $countries = $this->action === 'process_reg_step'
-            ? $this->country_model->get_all_countries()
-            : $this->country_model->get_all_active_countries();
-        // start with an empty option
-        $country_options = ['' => ''];
-        if (! empty($countries)) {
-            foreach ($countries as $country) {
-                if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
-                }
-            }
-        }
-        if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
-            $answer = $this->answer_model->get_one(
-                [['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
-            );
-        } else {
-            $answer = EE_Answer::new_instance();
-        }
-        $this->country_options[ $this->action ] = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
-            $country_options,
-            $registration,
-            $question,
-            $answer,
-            $this
-        );
-    }
+	/**
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateLegacyCountryOptions(EE_Question $question = null, EE_Registration $registration = null)
+	{
+		// get possibly cached list of countries
+		$countries = $this->action === 'process_reg_step'
+			? $this->country_model->get_all_countries()
+			: $this->country_model->get_all_active_countries();
+		// start with an empty option
+		$country_options = ['' => ''];
+		if (! empty($countries)) {
+			foreach ($countries as $country) {
+				if ($country instanceof EE_Country) {
+					$country_options[ $country->ID() ] = $country->name();
+				}
+			}
+		}
+		if ($question instanceof EE_Question && $registration instanceof EE_Registration) {
+			$answer = $this->answer_model->get_one(
+				[['QST_ID' => $question->ID(), 'REG_ID' => $registration->ID()]]
+			);
+		} else {
+			$answer = EE_Answer::new_instance();
+		}
+		$this->country_options[ $this->action ] = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
+			$country_options,
+			$registration,
+			$question,
+			$answer,
+			$this
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -74,10 +74,10 @@ 
         EE_Registration $registration = null,
         EE_Answer $answer = null
     ): array {
-        if (! isset($this->country_options[ $this->action ])) {
+        if ( ! isset($this->country_options[$this->action])) {
             $this->generateLegacyCountryOptions($question, $registration);
         }
-        return $this->country_options[ $this->action ];
+        return $this->country_options[$this->action];
     }
 
 
@@ -95,10 +95,10 @@ 
             : $this->country_model->get_all_active_countries();
         // start with an empty option
         $country_options = ['' => ''];
-        if (! empty($countries)) {
+        if ( ! empty($countries)) {
             foreach ($countries as $country) {
                 if ($country instanceof EE_Country) {
-                    $country_options[ $country->ID() ] = $country->name();
+                    $country_options[$country->ID()] = $country->name();
                 }
             }
         }
@@ -109,7 +109,7 @@ 
         } else {
             $answer = EE_Answer::new_instance();
         }
-        $this->country_options[ $this->action ] = apply_filters(
+        $this->country_options[$this->action] = apply_filters(
             'FHEE__EventEspresso_core_domain_services_registration_form_v1_CountryOptions__generateLegacyCountryOptions__country_options',
             $country_options,
             $registration,

core/domain/services/registration/form/v1/AutoCopyAttendeeInfoForm.php

Indentation +17 added lines, -17 removed lines

@@ -8,21 +8,21 @@
 class AutoCopyAttendeeInfoForm extends EE_Form_Section_HTML
 {
 
-    /**
-     * CopyAttendeeInfoForm constructor.
-     */
-    public function __construct(string $slug)
-    {
-        parent::__construct(
-            EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
-                    []
-                ),
-                true,
-                true
-            )
-        );
-    }
+	/**
+	 * CopyAttendeeInfoForm constructor.
+	 */
+	public function __construct(string $slug)
+	{
+		parent::__construct(
+			EEH_Template::locate_template(
+				SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
+					[]
+				),
+				true,
+				true
+			)
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
     {
         parent::__construct(
             EEH_Template::locate_template(
-                SPCO_REG_STEPS_PATH . $slug . '/_auto_copy_attendee_info.template.php',
+                SPCO_REG_STEPS_PATH.$slug.'/_auto_copy_attendee_info.template.php',
                 apply_filters(
                     'FHEE__EventEspresso_core_domain_services_registration_form_v1_AutoCopyAttendeeInfoForm__construct__template_args',
                     []

core/domain/services/registration/form/v1/RegistrantForm.php

Spacing +5 added lines, -5 removed lines

@@ -86,7 +86,7 @@ 
         $form_args = [];
         // verify that registration has valid event
         if ($registration->event() instanceof EE_Event) {
-            $field_name      = 'Event_Question_Group.' . $this->event_question_group_model->fieldNameForContext(
+            $field_name      = 'Event_Question_Group.'.$this->event_question_group_model->fieldNameForContext(
                 $registration->is_primary_registrant()
             );
             $question_groups = $registration->event()->question_groups(
@@ -106,7 +106,7 @@ 
             if ($question_groups) {
                 // array of params to pass to parent constructor
                 $form_args = [
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+                    'html_id'         => 'ee-registration-'.$registration->reg_url_link(),
                     'html_class'      => 'ee-reg-form-attendee-dv',
                     'html_style'      => $this->reg_step->checkout->admin_request
                         ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
@@ -132,7 +132,7 @@ 
                             RegFormQuestionGroup::class,
                             [$registration, $question_group, $this->reg_step]
                         );
-                        $form_args['subsections'][ $question_group->identifier() ] = apply_filters(
+                        $form_args['subsections'][$question_group->identifier()] = apply_filters(
                             'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
                             $question_group_reg_form,
                             $registration,
@@ -170,7 +170,7 @@ 
         $attendee_nmbr++;
 
         // Increment the reg forms number if form is valid.
-        if (! empty($form_args)) {
+        if ( ! empty($form_args)) {
             $this->has_questions = true;
         }
 
@@ -188,7 +188,7 @@ 
         // generate hidden input
         return new EE_Hidden_Input(
             [
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+                'html_id' => 'additional-attendee-reg-info-'.$registration->reg_url_link(),
                 'default' => true,
             ]
         );

Indentation +193 added lines, -193 removed lines

@@ -17,197 +17,197 @@
 
 class RegistrantForm extends EE_Form_Section_Proper
 {
-    /**
-     * @var EE_SPCO_Reg_Step_Attendee_Information
-     */
-    public $reg_step;
-
-    /**
-     * @var EEM_Event_Question_Group
-     */
-    public $event_question_group_model;
-
-    /**
-     * @var bool
-     */
-    private $has_questions = false;
-
-
-    /**
-     * RegistrantForm constructor.
-     *
-     * @param EE_Registration          $registration
-     * @param bool                     $copy_attendee_info
-     * @param callable                 $enablePrintCopyInfo
-     * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
-     * @param EEM_Event_Question_Group $event_question_group_model
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct(
-        EE_Registration $registration,
-        bool $copy_attendee_info,
-        callable $enablePrintCopyInfo,
-        EE_SPCO_Reg_Step_Attendee_Information $reg_step,
-        EEM_Event_Question_Group $event_question_group_model
-    ) {
-        $this->reg_step = $reg_step;
-        $this->event_question_group_model = $event_question_group_model;
-        parent::__construct(
-            $this->generateFormArgs($registration, $copy_attendee_info, $enablePrintCopyInfo)
-        );
-    }
-
-
-    /**
-     * @return bool
-     */
-    public function hasQuestions(): bool
-    {
-        return $this->has_questions;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @param bool            $copy_attendee_info
-     * @param callable        $enablePrintCopyInfo
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateFormArgs(
-        EE_Registration $registration,
-        bool $copy_attendee_info,
-        callable $enablePrintCopyInfo
-    ): array {
-        static $attendee_nmbr = 1;
-        $form_args = [];
-        // verify that registration has valid event
-        if ($registration->event() instanceof EE_Event) {
-            $field_name      = 'Event_Question_Group.' . $this->event_question_group_model->fieldNameForContext(
-                $registration->is_primary_registrant()
-            );
-            $question_groups = $registration->event()->question_groups(
-                apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
-                    [
-                        [
-                            'Event.EVT_ID' => $registration->event()->ID(),
-                            $field_name    => true,
-                            'QSG_deleted'  => false,
-                        ],
-                        'order_by' => ['QSG_order' => 'ASC'],
-                    ],
-                    $registration,
-                    $this
-                )
-            );
-            if ($question_groups) {
-                // array of params to pass to parent constructor
-                $form_args = [
-                    'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
-                    'html_class'      => 'ee-reg-form-attendee-dv',
-                    'html_style'      => $this->reg_step->checkout->admin_request
-                        ? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
-                        : '',
-                    'subsections'     => [],
-                    'layout_strategy' => new EE_Fieldset_Section_Layout(
-                        [
-                            'legend_class' => 'spco-attendee-lgnd',
-                            'legend_text'  => sprintf(
-                                esc_html_x(
-                                    'Attendee %d',
-                                    'Attendee 123',
-                                    'event_espresso'
-                                ),
-                                $attendee_nmbr
-                            ),
-                        ]
-                    ),
-                ];
-                foreach ($question_groups as $question_group) {
-                    if ($question_group instanceof EE_Question_Group) {
-                        $question_group_reg_form = LoaderFactory::getNew(
-                            RegFormQuestionGroup::class,
-                            [$registration, $question_group, $this->reg_step]
-                        );
-                        $form_args['subsections'][ $question_group->identifier() ] = apply_filters(
-                            'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
-                            $question_group_reg_form,
-                            $registration,
-                            $question_group,
-                            $this
-                        );
-                    }
-                }
-                // add hidden input
-                $form_args['subsections']['additional_attendee_reg_info'] = $this->additionalAttendeeRegInfoInput(
-                    $registration
-                );
-
-                // If we have question groups for additional attendees, then display the copy options
-                $printCopyInfo = apply_filters(
-                    'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
-                    $attendee_nmbr > 1 && $copy_attendee_info,
-                    $attendee_nmbr,
-                    $registration,
-                    $this
-                );
-                if ($printCopyInfo) {
-                    $enablePrintCopyInfo();
-                }
-
-
-                if ($registration->is_primary_registrant()) {
-                    // generate hidden input
-                    $form_args['subsections']['primary_registrant'] = $this->additionalPrimaryRegistrantInputs(
-                        $registration
-                    );
-                }
-            }
-        }
-        $attendee_nmbr++;
-
-        // Increment the reg forms number if form is valid.
-        if (! empty($form_args)) {
-            $this->has_questions = true;
-        }
-
-        return $form_args;
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function additionalAttendeeRegInfoInput(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
-                'default' => true,
-            ]
-        );
-    }
-
-
-    /**
-     * @param EE_Registration $registration
-     * @return    EE_Form_Input_Base
-     * @throws EE_Error
-     */
-    private function additionalPrimaryRegistrantInputs(EE_Registration $registration)
-    {
-        // generate hidden input
-        return new EE_Hidden_Input(
-            [
-                'html_id' => 'primary_registrant',
-                'default' => $registration->reg_url_link(),
-            ]
-        );
-    }
+	/**
+	 * @var EE_SPCO_Reg_Step_Attendee_Information
+	 */
+	public $reg_step;
+
+	/**
+	 * @var EEM_Event_Question_Group
+	 */
+	public $event_question_group_model;
+
+	/**
+	 * @var bool
+	 */
+	private $has_questions = false;
+
+
+	/**
+	 * RegistrantForm constructor.
+	 *
+	 * @param EE_Registration          $registration
+	 * @param bool                     $copy_attendee_info
+	 * @param callable                 $enablePrintCopyInfo
+	 * @param EE_SPCO_Reg_Step_Attendee_Information $reg_step
+	 * @param EEM_Event_Question_Group $event_question_group_model
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct(
+		EE_Registration $registration,
+		bool $copy_attendee_info,
+		callable $enablePrintCopyInfo,
+		EE_SPCO_Reg_Step_Attendee_Information $reg_step,
+		EEM_Event_Question_Group $event_question_group_model
+	) {
+		$this->reg_step = $reg_step;
+		$this->event_question_group_model = $event_question_group_model;
+		parent::__construct(
+			$this->generateFormArgs($registration, $copy_attendee_info, $enablePrintCopyInfo)
+		);
+	}
+
+
+	/**
+	 * @return bool
+	 */
+	public function hasQuestions(): bool
+	{
+		return $this->has_questions;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @param bool            $copy_attendee_info
+	 * @param callable        $enablePrintCopyInfo
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateFormArgs(
+		EE_Registration $registration,
+		bool $copy_attendee_info,
+		callable $enablePrintCopyInfo
+	): array {
+		static $attendee_nmbr = 1;
+		$form_args = [];
+		// verify that registration has valid event
+		if ($registration->event() instanceof EE_Event) {
+			$field_name      = 'Event_Question_Group.' . $this->event_question_group_model->fieldNameForContext(
+				$registration->is_primary_registrant()
+			);
+			$question_groups = $registration->event()->question_groups(
+				apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_groups_query_parameters',
+					[
+						[
+							'Event.EVT_ID' => $registration->event()->ID(),
+							$field_name    => true,
+							'QSG_deleted'  => false,
+						],
+						'order_by' => ['QSG_order' => 'ASC'],
+					],
+					$registration,
+					$this
+				)
+			);
+			if ($question_groups) {
+				// array of params to pass to parent constructor
+				$form_args = [
+					'html_id'         => 'ee-registration-' . $registration->reg_url_link(),
+					'html_class'      => 'ee-reg-form-attendee-dv',
+					'html_style'      => $this->reg_step->checkout->admin_request
+						? 'padding:0em 2em 1em; margin:3em 0 0; border:1px solid #ddd;'
+						: '',
+					'subsections'     => [],
+					'layout_strategy' => new EE_Fieldset_Section_Layout(
+						[
+							'legend_class' => 'spco-attendee-lgnd',
+							'legend_text'  => sprintf(
+								esc_html_x(
+									'Attendee %d',
+									'Attendee 123',
+									'event_espresso'
+								),
+								$attendee_nmbr
+							),
+						]
+					),
+				];
+				foreach ($question_groups as $question_group) {
+					if ($question_group instanceof EE_Question_Group) {
+						$question_group_reg_form = LoaderFactory::getNew(
+							RegFormQuestionGroup::class,
+							[$registration, $question_group, $this->reg_step]
+						);
+						$form_args['subsections'][ $question_group->identifier() ] = apply_filters(
+							'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__question_group_reg_form',
+							$question_group_reg_form,
+							$registration,
+							$question_group,
+							$this
+						);
+					}
+				}
+				// add hidden input
+				$form_args['subsections']['additional_attendee_reg_info'] = $this->additionalAttendeeRegInfoInput(
+					$registration
+				);
+
+				// If we have question groups for additional attendees, then display the copy options
+				$printCopyInfo = apply_filters(
+					'FHEE__EventEspresso_core_domain_services_registration_form_v1_RegistrantForm__generateFormArgs__printCopyInfo',
+					$attendee_nmbr > 1 && $copy_attendee_info,
+					$attendee_nmbr,
+					$registration,
+					$this
+				);
+				if ($printCopyInfo) {
+					$enablePrintCopyInfo();
+				}
+
+
+				if ($registration->is_primary_registrant()) {
+					// generate hidden input
+					$form_args['subsections']['primary_registrant'] = $this->additionalPrimaryRegistrantInputs(
+						$registration
+					);
+				}
+			}
+		}
+		$attendee_nmbr++;
+
+		// Increment the reg forms number if form is valid.
+		if (! empty($form_args)) {
+			$this->has_questions = true;
+		}
+
+		return $form_args;
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function additionalAttendeeRegInfoInput(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'additional-attendee-reg-info-' . $registration->reg_url_link(),
+				'default' => true,
+			]
+		);
+	}
+
+
+	/**
+	 * @param EE_Registration $registration
+	 * @return    EE_Form_Input_Base
+	 * @throws EE_Error
+	 */
+	private function additionalPrimaryRegistrantInputs(EE_Registration $registration)
+	{
+		// generate hidden input
+		return new EE_Hidden_Input(
+			[
+				'html_id' => 'primary_registrant',
+				'default' => $registration->reg_url_link(),
+			]
+		);
+	}
 }

core/domain/services/registration/form/v1/StateOptions.php

Indentation +85 added lines, -85 removed lines

@@ -12,97 +12,97 @@
 
 class StateOptions
 {
-    /**
-     * the action being performed on the current step
-     *
-     * @var string
-     */
-    public $action = '';
+	/**
+	 * the action being performed on the current step
+	 *
+	 * @var string
+	 */
+	public $action = '';
 
-    /**
-     * @var EEM_State
-     */
-    public $state_model;
+	/**
+	 * @var EEM_State
+	 */
+	public $state_model;
 
-    /**
-     * @var [][]
-     */
-    private $state_options = [];
+	/**
+	 * @var [][]
+	 */
+	private $state_options = [];
 
 
-    /**
-     * CountryOptions constructor.
-     *
-     * @param string    $action
-     * @param EEM_State $state_model
-     */
-    public function __construct(string $action, EEM_State $state_model)
-    {
-        $this->action      = $action;
-        $this->state_model = $state_model;
-        add_filter(
-            'FHEE__EE_Question__generate_form_input__state_options',
-            [$this, 'forLegacyFormInput'],
-            10,
-            4
-        );
-    }
+	/**
+	 * CountryOptions constructor.
+	 *
+	 * @param string    $action
+	 * @param EEM_State $state_model
+	 */
+	public function __construct(string $action, EEM_State $state_model)
+	{
+		$this->action      = $action;
+		$this->state_model = $state_model;
+		add_filter(
+			'FHEE__EE_Question__generate_form_input__state_options',
+			[$this, 'forLegacyFormInput'],
+			10,
+			4
+		);
+	}
 
 
-    /**
-     * Gets the list of states for the form input
-     *
-     * @param array|null           $states_list deprecated prop from an old hook
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @return array 2d keys are state IDs, values are their names
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function forLegacyFormInput(
-        array $states_list = null,
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ): array {
-        if (! isset($this->state_options[ $this->action ])) {
-            $this->generateLegacyStateOptions($question, $registration, $answer);
-        }
-        return $this->state_options[ $this->action ];
-    }
+	/**
+	 * Gets the list of states for the form input
+	 *
+	 * @param array|null           $states_list deprecated prop from an old hook
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @return array 2d keys are state IDs, values are their names
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function forLegacyFormInput(
+		array $states_list = null,
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	): array {
+		if (! isset($this->state_options[ $this->action ])) {
+			$this->generateLegacyStateOptions($question, $registration, $answer);
+		}
+		return $this->state_options[ $this->action ];
+	}
 
 
-    /**
-     * @param EE_Question|null     $question
-     * @param EE_Registration|null $registration
-     * @param EE_Answer|null       $answer
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function generateLegacyStateOptions(
-        EE_Question $question = null,
-        EE_Registration $registration = null,
-        EE_Answer $answer = null
-    ) {
-        $state_options = ['' => ['' => '']];
-        $states        = $this->action === 'process_reg_step'
-            ? $this->state_model->get_all_states()
-            : $this->state_model->get_all_active_states();
-        if (! empty($states)) {
-            foreach ($states as $state) {
-                if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
-                }
-            }
-        }
-        $this->state_options[ $this->action ] = apply_filters(
-            'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
-            $state_options,
-            $registration,
-            $question,
-            $answer,
-            $this
-        );
-    }
+	/**
+	 * @param EE_Question|null     $question
+	 * @param EE_Registration|null $registration
+	 * @param EE_Answer|null       $answer
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function generateLegacyStateOptions(
+		EE_Question $question = null,
+		EE_Registration $registration = null,
+		EE_Answer $answer = null
+	) {
+		$state_options = ['' => ['' => '']];
+		$states        = $this->action === 'process_reg_step'
+			? $this->state_model->get_all_states()
+			: $this->state_model->get_all_active_states();
+		if (! empty($states)) {
+			foreach ($states as $state) {
+				if ($state instanceof EE_State) {
+					$state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+				}
+			}
+		}
+		$this->state_options[ $this->action ] = apply_filters(
+			'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
+			$state_options,
+			$registration,
+			$question,
+			$answer,
+			$this
+		);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -66,10 +66,10 @@ 
         EE_Registration $registration = null,
         EE_Answer $answer = null
     ): array {
-        if (! isset($this->state_options[ $this->action ])) {
+        if ( ! isset($this->state_options[$this->action])) {
             $this->generateLegacyStateOptions($question, $registration, $answer);
         }
-        return $this->state_options[ $this->action ];
+        return $this->state_options[$this->action];
     }
 
 
@@ -89,14 +89,14 @@ 
         $states        = $this->action === 'process_reg_step'
             ? $this->state_model->get_all_states()
             : $this->state_model->get_all_active_states();
-        if (! empty($states)) {
+        if ( ! empty($states)) {
             foreach ($states as $state) {
                 if ($state instanceof EE_State) {
-                    $state_options[ $state->country()->name() ][ $state->ID() ] = $state->name();
+                    $state_options[$state->country()->name()][$state->ID()] = $state->name();
                 }
             }
         }
-        $this->state_options[ $this->action ] = apply_filters(
+        $this->state_options[$this->action] = apply_filters(
             'FHEE__EventEspresso_core_domain_services_registration_form_v1_StateOptions__generateLegacyStateOptions__state_options',
             $state_options,
             $registration,