eventespresso / event-espresso-core

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

Indentation +1272 added lines, -1272 removed lines

@@ -9,7 +9,7 @@ 
 use EE_Datetime_Field;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,1277 +27,1277 @@ 
 
 
 
-    /**
-     * @var Calculated_Model_Fields
-     */
-    protected $_fields_calculator;
-
-
-
-    /**
-     * Read constructor.
-     */
-    public function __construct()
-    {
-        parent::__construct();
-        $this->_fields_calculator = new Calculated_Model_Fields();
-    }
-
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_all(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
-                array('version', 'model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $model_name Something like `Event` or `Registration`
-     * @param string $version    The API endpoint version being used.
-     * @return array
-     */
-    public static function handle_schema_request($model_name, $version)
-    {
-        $controller = new Read();
-        try {
-            $controller->set_requested_version($version);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
-                return array();
-            }
-            //get the model for this version
-            $model = $controller->get_model_version_info()->load_model($model_name);
-            $model_schema = new JsonModelSchema($model);
-            return $model_schema->getModelSchemaForRelations(
-                $controller->get_model_version_info()->relation_settings($model),
-                $controller->_customize_schema_for_rest_response(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->get_model_version_info()->fields_on_model_in_this_version($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (\Exception $e) {
-            return array();
-        }
-    }
-
-
-
-    /**
-     * 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.
-     */
-    protected function _customize_schema_for_rest_response(\EEM_Base $model, array $schema)
-    {
-        foreach ($this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name => $field) {
-            $schema = $this->_translate_defaults_for_rest_response(
-                $field_name,
-                $field,
-                $this->_maybe_add_extra_fields_to_schema($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
-     */
-    protected function _translate_defaults_for_rest_response($field_name, \EE_Model_Field_Base $field, array $schema)
-    {
-        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] = Model_Data_Translator::prepare_field_value_for_json(
-                            $field,
-                            $default_value,
-                            $this->get_model_version_info()->requested_version()
-                        );
-                    }
-                }
-            } else {
-                $schema['properties'][$field_name]['default'] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field,
-                    $schema['properties'][$field_name]['default'],
-                    $this->get_model_version_info()->requested_version()
-                );
-            }
-        }
-        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 _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
-    {
-        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'),
-                $field->get_nicename()
-            );
-        }
-        return $schema;
-    }
-
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function get_route_from_request()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param \WP_REST_Request $request
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_one(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
-                array('version', 'model', 'id'));
-            $controller->set_requested_version($matches['version']);
-            $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entity_from_model(
-                    $controller->get_model_version_info()->load_model($model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($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
-     * @return \WP_REST_Response|\WP_Error
-     */
-    public static function handle_request_get_related(\WP_REST_Request $request)
-    {
-        $controller = new Read();
-        try {
-            $matches = $controller->parse_route(
-                $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
-                array('version', 'model', 'id', 'related_model')
-            );
-            $controller->set_requested_version($matches['version']);
-            $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $main_model_name_singular
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
-            //assume the related model name is plural and try to find the model's name
-            $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                //so the word didn't singularize well. Maybe that's just because it's a singular word?
-                $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
-            }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
-                return $controller->send_response(
-                    new \WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __('There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'),
-                            $related_model_name_singular
-                        )
-                    )
-                );
-            }
-            return $controller->send_response(
-                $controller->get_entities_from_relation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name_singular),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->send_response($e);
-        }
-    }
-
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entities_from_model($model, $request)
-    {
-        $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
-            $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::get_missing_permissions_string($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->_set_headers_from_query_params($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->create_entity_from_wpdb_result(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_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 \WP_Error|array
-     */
-    protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validate_context($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] = array();
-        }
-        //check if they can access the 1st model object
-        $primary_model_query_params = array(
-            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;
-        $this->_set_debug_info('main model query params', $restricted_query_params);
-        $this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
-        if (
-        ! (
-            Capabilities::current_user_has_partial_access_to($related_model, $context)
-            && $model->exists($restricted_query_params)
-        )
-        ) {
-            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());
-            }
-            return new \WP_Error(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __('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::get_missing_permissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->create_model_query_params($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->_set_headers_from_query_params($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->create_entity_from_wpdb_result(
-                $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->create_entity_from_wpdb_result(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                //but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof \EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param \WP_REST_Request        $request
-     * @return array|\WP_Error
-     * @throws \EE_Error
-     */
-    public function get_entities_from_relation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        'event_espresso'),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->_get_entities_from_relation(
-            array(
-                array(
-                    $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
-     */
-    protected function _set_headers_from_query_params($model, $query_params)
-    {
-        $this->_set_debug_info('model query params', $query_params);
-        $this->_set_debug_info('missing caps',
-            Capabilities::get_missing_permissions_string($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 = array(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->_set_response_header('Total', $count, false);
-        $this->_set_response_header('PageSize', $limit_parts[1], false);
-        $this->_set_response_header('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 $rest_request
-     * @param string           $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
-    {
-        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);
-        }
-        $entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
-        $entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
-        $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);
-        $entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
-        $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
-        );
-        $result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->get_model_version_info(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->_set_debug_info(
-            'inaccessible fields',
-            array_keys(array_diff_key($entity_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')
-        );
-    }
-
-
-
-    /**
-     * 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
-     */
-    protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key($result,
-            $this->get_model_version_info()->fields_on_model_in_this_version($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 Rest_Exception(
-                    '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 => $raw_field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            $field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
-            if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
-                unset($result[$field_name]);
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'      => $field_obj->prepare_for_get($field_value),
-                    'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif (
-            $this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
-            ) {
-                $result[$field_name] = array(
-                    'raw'    => $field_obj->prepare_for_get($field_value),
-                    'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                if ($field_value instanceof \DateTime) {
-                    $timezone = $field_value->getTimezone();
-                    $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                    $field_value->setTimezone($timezone);
-                    $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                        $field_obj,
-                        $field_value,
-                        $this->get_model_version_info()->requested_version()
-                    );
-                }
-            } else {
-                $result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $field_obj->prepare_for_get($field_value),
-                    $this->get_model_version_info()->requested_version()
-                );
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-
-    /**
-     * 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
-     */
-    protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_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
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param \EEM_Base        $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function _get_entity_links($model, $db_row, $entity_array)
-    {
-        //add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->get_versioned_link_to(
-                        \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[$model->primary_key_name()]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->get_versioned_link_to(
-                    \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        //add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
-                    array(
-                        'href'   => $this->get_versioned_link_to(
-                            \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 ? true : false,
-                    ),
-                );
-            }
-        }
-        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
-     * @return array the modified entity
-     */
-    protected function _include_requested_models(
-        \EEM_Base $model,
-        \WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array()
-    ) {
-        //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
-        //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                //always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->get_model_version_info()->relation_settings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explode_and_get_items_prefixed_with(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
-                $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(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                    )
-                );
-                $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)
-                    )
-                );
-                $related_results = $this->_get_entities_from_relation(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
-                                                                                              instanceof
-                                                                                              \WP_Error
-                    ? null
-                    : $related_results;
-            }
-        }
-        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 $arr
-     * @return array
-     */
-    private function _remove_model_names_from_array($arr)
-    {
-        return array_diff($arr, 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
-     * @return \stdClass the _calculations item in the entity
-     */
-    protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explode_and_get_items_prefixed_with(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        //note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                $calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
-                    null,
-                    $this->_fields_calculator->retrieve_calculated_field_value(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->get_model_version_info()->requested_version()
-                );
-            } catch (Rest_Exception $e) {
-                //if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->_set_response_header(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->get_string_code()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        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"
-     */
-    public function get_versioned_link_to($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            \EED_Core_Rest_Api::ee_api_namespace
-            . $this->get_model_version_info()->requested_version()
-            . '/'
-            . $link_part_after_version_and_slash
-        );
-    }
-
-
-
-    /**
-     * 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 get_related_entity_name($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof \EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return \EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param \EEM_Base        $model
-     * @param \WP_REST_Request $request
-     * @return array|\WP_Error
-     */
-    public function get_entity_from_model($model, $request)
-    {
-        $query_params = array(array($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'] = $this->validate_context($request->get_param('caps'));
-        $this->_set_debug_info('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty ($model_rows)) {
-            return $this->create_entity_from_wpdb_result(
-                $model,
-                array_shift($model_rows),
-                $request);
-        } else {
-            //ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
-                //you got shafted- it existed but we didn't want to tell you!
-                return new \WP_Error(
-                    'rest_user_cannot_read',
-                    sprintf(
-                        __('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::get_missing_permissions_string(
-                            $model,
-                            $this->validate_context($request->get_param('caps')))
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                //it's not you. It just doesn't exist
-                return new \WP_Error(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validate_context($context)
-    {
-        if (! $context) {
-            $context = \EEM_Base::caps_read;
-        }
-        $valid_contexts = \EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return \EEM_Base::caps_read;
-        }
-    }
-
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validate_default_query_params($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            \EEM_Base::default_where_conditions_all,
-            \EEM_Base::default_where_conditions_minimum_all,
-            \EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = \EEM_Base::default_where_conditions_all;
-        }
-        if (
-        in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )
-        ) {
-            return $default_query_params;
-        } else {
-            return \EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-
-    /**
-     * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
-     * 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
-     *
-     * @param \EEM_Base $model
-     * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
-     * @return array like what EEM_Base::get_all() expects or FALSE to indicate
-     *                                    that absolutely no results should be returned
-     * @throws \EE_Error
-     */
-    public function create_model_query_params($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['where'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order_by'])) {
-            $order_by = $query_parameters['order_by'];
-        } elseif (isset($query_parameters['orderby'])) {
-            $order_by = $query_parameters['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
-            } else {
-                //it's a single item
-                $order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_parameters['group_by'])) {
-            $group_by = $query_parameters['group_by'];
-        } elseif (isset($query_parameters['groupby'])) {
-            $group_by = $query_parameters['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 = Model_Data_Translator::prepare_field_names_from_json($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
-                $query_parameters['having'],
-                $model,
-                $this->get_model_version_info()->requested_version()
-            );
-        }
-        if (isset($query_parameters['order'])) {
-            $model_query_params['order'] = $query_parameters['order'];
-        }
-        if (isset($query_parameters['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_parameters['limit'])) {
-            //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
-            } else {
-                $limit_array = $query_parameters['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new \EE_Error(
-                        sprintf(
-                            __('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.',
-                                'event_espresso'),
-                            wp_json_encode($query_parameters['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_parameters['caps'])) {
-            $model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
-        } else {
-            $model_query_params['caps'] = \EEM_Base::caps_read;
-        }
-        if (isset($query_parameters['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
-        }
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
-    }
-
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param \EEM_Base $model
-     * @param array     $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepare_rest_query_params_key_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
-            } else {
-                $model_ready_query_params[$key] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-
-    /**
-     * @deprecated
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepare_rest_query_params_values_for_models($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($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, blaabla" 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 explode_and_get_items_prefixed_with($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } else if (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        //if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        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;
-                }
-            } else if (strpos($item, $prefix . '.') === 0) {
-                //this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } else if ($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;
-    }
-
-
-
-    /**
-     * @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).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $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
-     */
-    public function extract_includes_for_this_model($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        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->get_model_version_info()->is_model_name_in_this_version($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
+	/**
+	 * @var Calculated_Model_Fields
+	 */
+	protected $_fields_calculator;
+
+
+
+	/**
+	 * Read constructor.
+	 */
+	public function __construct()
+	{
+		parent::__construct();
+		$this->_fields_calculator = new Calculated_Model_Fields();
+	}
+
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_all(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+				array('version', 'model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @param string $version    The API endpoint version being used.
+	 * @return array
+	 */
+	public static function handle_schema_request($model_name, $version)
+	{
+		$controller = new Read();
+		try {
+			$controller->set_requested_version($version);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
+				return array();
+			}
+			//get the model for this version
+			$model = $controller->get_model_version_info()->load_model($model_name);
+			$model_schema = new JsonModelSchema($model);
+			return $model_schema->getModelSchemaForRelations(
+				$controller->get_model_version_info()->relation_settings($model),
+				$controller->_customize_schema_for_rest_response(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->get_model_version_info()->fields_on_model_in_this_version($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (\Exception $e) {
+			return array();
+		}
+	}
+
+
+
+	/**
+	 * 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.
+	 */
+	protected function _customize_schema_for_rest_response(\EEM_Base $model, array $schema)
+	{
+		foreach ($this->get_model_version_info()->fields_on_model_in_this_version($model) as $field_name => $field) {
+			$schema = $this->_translate_defaults_for_rest_response(
+				$field_name,
+				$field,
+				$this->_maybe_add_extra_fields_to_schema($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
+	 */
+	protected function _translate_defaults_for_rest_response($field_name, \EE_Model_Field_Base $field, array $schema)
+	{
+		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] = Model_Data_Translator::prepare_field_value_for_json(
+							$field,
+							$default_value,
+							$this->get_model_version_info()->requested_version()
+						);
+					}
+				}
+			} else {
+				$schema['properties'][$field_name]['default'] = Model_Data_Translator::prepare_field_value_for_json(
+					$field,
+					$schema['properties'][$field_name]['default'],
+					$this->get_model_version_info()->requested_version()
+				);
+			}
+		}
+		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 _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
+	{
+		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'),
+				$field->get_nicename()
+			);
+		}
+		return $schema;
+	}
+
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function get_route_from_request()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param \WP_REST_Request $request
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_one(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+				array('version', 'model', 'id'));
+			$controller->set_requested_version($matches['version']);
+			$model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entity_from_model(
+					$controller->get_model_version_info()->load_model($model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($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
+	 * @return \WP_REST_Response|\WP_Error
+	 */
+	public static function handle_request_get_related(\WP_REST_Request $request)
+	{
+		$controller = new Read();
+		try {
+			$matches = $controller->parse_route(
+				$request->get_route(),
+				'~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+				array('version', 'model', 'id', 'related_model')
+			);
+			$controller->set_requested_version($matches['version']);
+			$main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$main_model_name_singular
+						)
+					)
+				);
+			}
+			$main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
+			//assume the related model name is plural and try to find the model's name
+			$related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				//so the word didn't singularize well. Maybe that's just because it's a singular word?
+				$related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
+			}
+			if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+				return $controller->send_response(
+					new \WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__('There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'),
+							$related_model_name_singular
+						)
+					)
+				);
+			}
+			return $controller->send_response(
+				$controller->get_entities_from_relation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name_singular),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->send_response($e);
+		}
+	}
+
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entities_from_model($model, $request)
+	{
+		$query_params = $this->create_model_query_params($model, $request->get_params());
+		if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+			$model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::get_missing_permissions_string($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->_set_headers_from_query_params($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->create_entity_from_wpdb_result(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_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 \WP_Error|array
+	 */
+	protected function _get_entities_from_relation($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validate_context($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] = array();
+		}
+		//check if they can access the 1st model object
+		$primary_model_query_params = array(
+			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;
+		$this->_set_debug_info('main model query params', $restricted_query_params);
+		$this->_set_debug_info('missing caps', Capabilities::get_missing_permissions_string($related_model, $context));
+		if (
+		! (
+			Capabilities::current_user_has_partial_access_to($related_model, $context)
+			&& $model->exists($restricted_query_params)
+		)
+		) {
+			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());
+			}
+			return new \WP_Error(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__('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::get_missing_permissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->create_model_query_params($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->_set_headers_from_query_params($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->create_entity_from_wpdb_result(
+				$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->create_entity_from_wpdb_result(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				//but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof \EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param \WP_REST_Request        $request
+	 * @return array|\WP_Error
+	 * @throws \EE_Error
+	 */
+	public function get_entities_from_relation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new \EE_Error(
+				sprintf(
+					__('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						'event_espresso'),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->_get_entities_from_relation(
+			array(
+				array(
+					$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
+	 */
+	protected function _set_headers_from_query_params($model, $query_params)
+	{
+		$this->_set_debug_info('model query params', $query_params);
+		$this->_set_debug_info('missing caps',
+			Capabilities::get_missing_permissions_string($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 = array(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->_set_response_header('Total', $count, false);
+		$this->_set_response_header('PageSize', $limit_parts[1], false);
+		$this->_set_response_header('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 $rest_request
+	 * @param string           $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
+	{
+		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);
+		}
+		$entity_array = $this->_create_bare_entity_from_wpdb_results($model, $db_row);
+		$entity_array = $this->_add_extra_fields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->_get_entity_links($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->_get_entity_calculations($model, $db_row, $rest_request);
+		$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);
+		$entity_array = $this->_include_requested_models($model, $rest_request, $entity_array, $db_row);
+		$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
+		);
+		$result_without_inaccessible_fields = Capabilities::filter_out_inaccessible_entity_fields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->get_model_version_info(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->_set_debug_info(
+			'inaccessible fields',
+			array_keys(array_diff_key($entity_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')
+		);
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	protected function _create_bare_entity_from_wpdb_results(\EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key($result,
+			$this->get_model_version_info()->fields_on_model_in_this_version($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 Rest_Exception(
+					'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 => $raw_field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			$field_value = $field_obj->prepare_for_set_from_db($raw_field_value);
+			if ($this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_ignored())) {
+				unset($result[$field_name]);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_rendered_format())
+			) {
+				$result[$field_name] = array(
+					'raw'      => $field_obj->prepare_for_get($field_value),
+					'rendered' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif (
+			$this->is_subclass_of_one($field_obj, $this->get_model_version_info()->fields_that_have_pretty_format())
+			) {
+				$result[$field_name] = array(
+					'raw'    => $field_obj->prepare_for_get($field_value),
+					'pretty' => $field_obj->prepare_for_pretty_echoing($field_value),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				if ($field_value instanceof \DateTime) {
+					$timezone = $field_value->getTimezone();
+					$field_value->setTimezone(new \DateTimeZone('UTC'));
+					$result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+					$field_value->setTimezone($timezone);
+					$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+						$field_obj,
+						$field_value,
+						$this->get_model_version_info()->requested_version()
+					);
+				}
+			} else {
+				$result[$field_name] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$field_obj->prepare_for_get($field_value),
+					$this->get_model_version_info()->requested_version()
+				);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	protected function _add_extra_fields(\EEM_Base $model, $db_row, $entity_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
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param \EEM_Base        $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function _get_entity_links($model, $db_row, $entity_array)
+	{
+		//add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->get_versioned_link_to(
+						\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[$model->primary_key_name()]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->get_versioned_link_to(
+					\EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		//add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
+				$links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+					array(
+						'href'   => $this->get_versioned_link_to(
+							\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 ? true : false,
+					),
+				);
+			}
+		}
+		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
+	 * @return array the modified entity
+	 */
+	protected function _include_requested_models(
+		\EEM_Base $model,
+		\WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array()
+	) {
+		//if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
+		//if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				//always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explode_and_get_items_prefixed_with($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->get_model_version_info()->relation_settings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explode_and_get_items_prefixed_with(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explode_and_get_items_prefixed_with(
+				$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(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+					)
+				);
+				$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)
+					)
+				);
+				$related_results = $this->_get_entities_from_relation(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[Read::get_related_entity_name($relation_name, $relation_obj)] = $related_results
+																							  instanceof
+																							  \WP_Error
+					? null
+					: $related_results;
+			}
+		}
+		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 $arr
+	 * @return array
+	 */
+	private function _remove_model_names_from_array($arr)
+	{
+		return array_diff($arr, 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
+	 * @return \stdClass the _calculations item in the entity
+	 */
+	protected function _get_entity_calculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explode_and_get_items_prefixed_with(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		//note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				$calculated_fields_to_return->$field_to_calculate = Model_Data_Translator::prepare_field_value_for_json(
+					null,
+					$this->_fields_calculator->retrieve_calculated_field_value(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->get_model_version_info()->requested_version()
+				);
+			} catch (Rest_Exception $e) {
+				//if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->_set_response_header(
+					'Notices-Field-Calculation-Errors['
+					. $e->get_string_code()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		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"
+	 */
+	public function get_versioned_link_to($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			\EED_Core_Rest_Api::ee_api_namespace
+			. $this->get_model_version_info()->requested_version()
+			. '/'
+			. $link_part_after_version_and_slash
+		);
+	}
+
+
+
+	/**
+	 * 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 get_related_entity_name($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof \EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return \EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param \EEM_Base        $model
+	 * @param \WP_REST_Request $request
+	 * @return array|\WP_Error
+	 */
+	public function get_entity_from_model($model, $request)
+	{
+		$query_params = array(array($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'] = $this->validate_context($request->get_param('caps'));
+		$this->_set_debug_info('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty ($model_rows)) {
+			return $this->create_entity_from_wpdb_result(
+				$model,
+				array_shift($model_rows),
+				$request);
+		} else {
+			//ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			$model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
+			if (! empty($model_rows_found_sans_restrictions)) {
+				//you got shafted- it existed but we didn't want to tell you!
+				return new \WP_Error(
+					'rest_user_cannot_read',
+					sprintf(
+						__('Sorry, you cannot read this %1$s. Missing permissions are: %2$s', 'event_espresso'),
+						strtolower($model->get_this_model_name()),
+						Capabilities::get_missing_permissions_string(
+							$model,
+							$this->validate_context($request->get_param('caps')))
+					),
+					array('status' => 403)
+				);
+			} else {
+				//it's not you. It just doesn't exist
+				return new \WP_Error(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validate_context($context)
+	{
+		if (! $context) {
+			$context = \EEM_Base::caps_read;
+		}
+		$valid_contexts = \EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return \EEM_Base::caps_read;
+		}
+	}
+
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validate_default_query_params($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			\EEM_Base::default_where_conditions_all,
+			\EEM_Base::default_where_conditions_minimum_all,
+			\EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = \EEM_Base::default_where_conditions_all;
+		}
+		if (
+		in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)
+		) {
+			return $default_query_params;
+		} else {
+			return \EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+
+	/**
+	 * Translates API filter get parameter into $query_params array used by EEM_Base::get_all().
+	 * 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
+	 *
+	 * @param \EEM_Base $model
+	 * @param array     $query_parameters from $_GET parameter @see Read:handle_request_get_all
+	 * @return array like what EEM_Base::get_all() expects or FALSE to indicate
+	 *                                    that absolutely no results should be returned
+	 * @throws \EE_Error
+	 */
+	public function create_model_query_params($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['where'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order_by'])) {
+			$order_by = $query_parameters['order_by'];
+		} elseif (isset($query_parameters['orderby'])) {
+			$order_by = $query_parameters['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = Model_Data_Translator::prepare_field_names_in_array_keys_from_json($order_by);
+			} else {
+				//it's a single item
+				$order_by = Model_Data_Translator::prepare_field_name_from_json($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_parameters['group_by'])) {
+			$group_by = $query_parameters['group_by'];
+		} elseif (isset($query_parameters['groupby'])) {
+			$group_by = $query_parameters['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 = Model_Data_Translator::prepare_field_names_from_json($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_models(
+				$query_parameters['having'],
+				$model,
+				$this->get_model_version_info()->requested_version()
+			);
+		}
+		if (isset($query_parameters['order'])) {
+			$model_query_params['order'] = $query_parameters['order'];
+		}
+		if (isset($query_parameters['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_parameters['limit'])) {
+			//limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_parameters['limit'])) {
+				$limit_array = explode(',', (string)$query_parameters['limit']);
+			} else {
+				$limit_array = $query_parameters['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->_debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new \EE_Error(
+						sprintf(
+							__('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.',
+								'event_espresso'),
+							wp_json_encode($query_parameters['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_parameters['caps'])) {
+			$model_query_params['caps'] = $this->validate_context($query_parameters['caps']);
+		} else {
+			$model_query_params['caps'] = \EEM_Base::caps_read;
+		}
+		if (isset($query_parameters['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validate_default_query_params($query_parameters['default_where_conditions']);
+		}
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_parameters, $model);
+	}
+
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param \EEM_Base $model
+	 * @param array     $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepare_rest_query_params_key_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_key_for_models($model, $value);
+			} else {
+				$model_ready_query_params[$key] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+
+	/**
+	 * @deprecated
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepare_rest_query_params_values_for_models($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[$key] = $this->prepare_rest_query_params_values_for_models($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, blaabla" 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 explode_and_get_items_prefixed_with($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} else if (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		//if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		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;
+				}
+			} else if (strpos($item, $prefix . '.') === 0) {
+				//this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} else if ($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;
+	}
+
+
+
+	/**
+	 * @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).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $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
+	 */
+	public function extract_includes_for_this_model($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		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->get_model_version_info()->is_model_name_in_this_version($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
 }
 
 

Spacing +38 added lines, -38 removed lines

@@ -8,7 +8,7 @@ 
 use EventEspresso\core\entities\models\JsonModelSchema;
 use EE_Datetime_Field;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -57,12 +57,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)~',
                 array('version', 'model')
             );
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -99,7 +99,7 @@ 
         $controller = new Read();
         try {
             $controller->set_requested_version($version);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name)) {
                 return array();
             }
             //get the model for this version
@@ -193,9 +193,9 @@ 
     protected function _maybe_add_extra_fields_to_schema($field_name, \EE_Model_Field_Base $field, array $schema)
     {
         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'),
                 $field->get_nicename()
             );
@@ -236,11 +236,11 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)~',
                 array('version', 'model', 'id'));
             $controller->set_requested_version($matches['version']);
             $model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -278,12 +278,12 @@ 
         try {
             $matches = $controller->parse_route(
                 $request->get_route(),
-                '~' . \EED_Core_Rest_Api::ee_api_namespace_for_regex . '(.*)/(.*)/(.*)~',
+                '~'.\EED_Core_Rest_Api::ee_api_namespace_for_regex.'(.*)/(.*)/(.*)~',
                 array('version', 'model', 'id', 'related_model')
             );
             $controller->set_requested_version($matches['version']);
             $main_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($main_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -298,11 +298,11 @@ 
             $main_model = $controller->get_model_version_info()->load_model($main_model_name_singular);
             //assume the related model name is plural and try to find the model's name
             $related_model_name_singular = \EEH_Inflector::singularize_and_upper($matches['related_model']);
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 //so the word didn't singularize well. Maybe that's just because it's a singular word?
                 $related_model_name_singular = \EEH_Inflector::humanize($matches['related_model']);
             }
-            if (! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
+            if ( ! $controller->get_model_version_info()->is_model_name_in_this_version($related_model_name_singular)) {
                 return $controller->send_response(
                     new \WP_Error(
                         'endpoint_parsing_error',
@@ -338,7 +338,7 @@ 
     public function get_entities_from_model($model, $request)
     {
         $query_params = $this->create_model_query_params($model, $request->get_params());
-        if (! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
+        if ( ! Capabilities::current_user_has_partial_access_to($model, $query_params['caps'])) {
             $model_name_plural = \EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new \WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -350,7 +350,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->_set_headers_from_query_params($model, $query_params);
         }
         /** @type array $results */
@@ -380,7 +380,7 @@ 
         $context = $this->validate_context($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] = array();
         }
         //check if they can access the 1st model object
@@ -431,7 +431,7 @@ 
         }
         $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->_set_headers_from_query_params($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -483,7 +483,7 @@ 
      */
     public function get_entities_from_relation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new \EE_Error(
                 sprintf(
                     __('Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
@@ -520,7 +520,7 @@ 
         $this->_set_debug_info('missing caps',
             Capabilities::get_missing_permissions_string($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'])) {
@@ -554,7 +554,7 @@ 
      */
     public function create_entity_from_wpdb_result($model, $db_row, $rest_request, $deprecated = null)
     {
-        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
@@ -629,7 +629,7 @@ 
             global $post;
             $old_post = $post;
             $post = get_post($result[$model->primary_key_name()]);
-            if (! $post instanceof \WP_Post) {
+            if ( ! $post instanceof \WP_Post) {
                 //well that's weird, because $result is what we JUST fetched from the database
                 throw new Rest_Exception(
                     'error_fetching_post_from_database_results',
@@ -639,7 +639,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,
@@ -670,7 +670,7 @@ 
                 if ($field_value instanceof \DateTime) {
                     $timezone = $field_value->getTimezone();
                     $field_value->setTimezone(new \DateTimeZone('UTC'));
-                    $result[$field_name . '_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
+                    $result[$field_name.'_gmt'] = Model_Data_Translator::prepare_field_value_for_json(
                         $field_obj,
                         $field_value,
                         $this->get_model_version_info()->requested_version()
@@ -751,7 +751,7 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->get_model_version_info()->relation_settings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::get_related_entity_name($relation_name, $relation_obj);
-                $links[\EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part] = array(
+                $links[\EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->get_versioned_link_to(
                             \EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
@@ -786,13 +786,13 @@ 
         $db_row = array()
     ) {
         //if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $includes_for_this_model = $this->explode_and_get_items_prefixed_with($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->_remove_model_names_from_array($includes_for_this_model);
         //if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -967,7 +967,7 @@ 
         $restricted_query_params['caps'] = $this->validate_context($request->get_param('caps'));
         $this->_set_debug_info('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->create_entity_from_wpdb_result(
                 $model,
                 array_shift($model_rows),
@@ -976,7 +976,7 @@ 
             //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());
             $model_rows_found_sans_restrictions = $model->get_all_wpdb_results($query_params);
-            if (! empty($model_rows_found_sans_restrictions)) {
+            if ( ! empty($model_rows_found_sans_restrictions)) {
                 //you got shafted- it existed but we didn't want to tell you!
                 return new \WP_Error(
                     'rest_user_cannot_read',
@@ -1011,7 +1011,7 @@ 
      */
     public function validate_context($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = \EEM_Base::caps_read;
         }
         $valid_contexts = \EEM_Base::valid_cap_contexts();
@@ -1037,7 +1037,7 @@ 
             \EEM_Base::default_where_conditions_minimum_all,
             \EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = \EEM_Base::default_where_conditions_all;
         }
         if (
@@ -1122,14 +1122,14 @@ 
         }
         if (isset($query_parameters['limit'])) {
             //limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_parameters['limit'])) {
-                $limit_array = explode(',', (string)$query_parameters['limit']);
+            if ( ! is_array($query_parameters['limit'])) {
+                $limit_array = explode(',', (string) $query_parameters['limit']);
             } else {
                 $limit_array = $query_parameters['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $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(
                             __('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.',
@@ -1138,7 +1138,7 @@ 
                         )
                     );
                 }
-                $sanitized_limit[] = (int)$limit_part;
+                $sanitized_limit[] = (int) $limit_part;
             }
             $model_query_params['limit'] = implode(',', $sanitized_limit);
         } else {
@@ -1226,17 +1226,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;
                 }
-            } else if (strpos($item, $prefix . '.') === 0) {
+            } else if (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.'.')
                 );
             } else if ($item === $prefix) {
                 //this item is JUST the prefix
@@ -1276,9 +1276,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[] = '*';

core/services/shortcodes/EspressoShortcode.php

Indentation +227 added lines, -227 removed lines

@@ -23,233 +23,233 @@
 abstract class EspressoShortcode implements ShortcodeInterface
 {
 
-    /**
-     * transient prefix
-     *
-     * @type string
-     */
-    const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
-
-    /**
-     * @var PostRelatedCacheManager $cache_manager
-     */
-    private $cache_manager;
-
-    /**
-     * true if ShortcodeInterface::initializeShortcode() has been called
-     * if false, then that will get called before processing
-     *
-     * @var boolean $initialized
-     */
-    private $initialized = false;
-
-
-
-    /**
-     * EspressoShortcode constructor
-     *
-     * @param PostRelatedCacheManager $cache_manager
-     */
-    public function __construct(PostRelatedCacheManager $cache_manager)
-    {
-        $this->cache_manager = $cache_manager;
-    }
-
-
-
-    /**
-     * @return void
-     */
-    public function shortcodeHasBeenInitialized()
-    {
-        $this->initialized = true;
-    }
-
-
-
-    /**
-     * enqueues scripts then processes the shortcode
-     *
-     * @param array $attributes
-     * @return string
-     * @throws EE_Error
-     */
-    final public function processShortcodeCallback($attributes = array())
-    {
-        if ($this instanceof EnqueueAssetsInterface) {
-            if (is_admin()) {
-                $this->enqueueAdminScripts();
-            } else {
-                $this->enqueueScripts();
-            }
-        }
-        return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
-        );
-    }
-
-
-
-    /**
-     * If shortcode caching is enabled for the shortcode,
-     * and cached results exist, then that will be returned
-     * else new content will be generated.
-     * If caching is enabled, then the new content will be cached for later.
-     *
-     * @param array $attributes
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    private function shortcodeContent(array $attributes)
-    {
-        $shortcode = $this;
-        $post_ID = $this->currentPostID();
-        // something like "SC_EVENTS-123"
-        $cache_ID = $this->shortcodeCacheID($post_ID);
-        $this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
-        return $this->cache_manager->get(
-            $cache_ID,
-            // serialized attributes
-            wp_json_encode($attributes),
-            // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized() === false){
-                    $shortcode->initializeShortcode();
-                }
-                return $shortcode->processShortcode($attributes);
-            },
-            // filterable cache expiration set by each shortcode
-            apply_filters(
-                'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
-                $this->cacheExpiration(),
-                $this->getTag(),
-                $this
-            )
-        );
-    }
-
-
-
-    /**
-     * @return int
-     * @throws EE_Error
-     */
-    private function currentPostID()
-    {
-        // try to get EE_Event any way we can
-        $event = EEH_Event_View::get_event();
-        // then get some kind of ID
-        if ($event instanceof EE_Event) {
-            return $event->ID();
-        }
-        global $post;
-        if ($post instanceof EE_Event) {
-            return $post->ID();
-        }
-        if ($post instanceof WP_Post) {
-            return $post->ID;
-        }
-        return 0;
-    }
-
-
-
-    /**
-     * @param int $post_ID
-     * @return string
-     * @throws EE_Error
-     */
-    private function shortcodeCacheID($post_ID)
-    {
-        $tag = str_replace('ESPRESSO_', '', $this->getTag());
-        return "SC_{$tag}-{$post_ID}";
-    }
-
-
-
-    /**
-     * array for defining custom attribute sanitization callbacks,
-     * where keys match keys in your attributes array,
-     * and values represent the sanitization function you wish to be applied to that attribute.
-     * So for example, if you had an integer attribute named "event_id"
-     * that you wanted to be sanitized using absint(),
-     * then you would return the following:
-     *      array('event_id' => 'absint')
-     * Entering 'skip_sanitization' for the callback value
-     * means that no sanitization will be applied
-     * on the assumption that the attribute
-     * will be sanitized at some point... right?
-     * You wouldn't pass around unsanitized attributes would you?
-     * That would be very Tom Foolery of you!!!
-     *
-     * @return array
-     */
-    protected function customAttributeSanitizationMap()
-    {
-        return array();
-    }
-
-
-
-    /**
-     * Performs basic sanitization on shortcode attributes
-     * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
-     * most attributes will by default be sanitized using the sanitize_text_field() function.
-     * This can be overridden using the customAttributeSanitizationMap() method (see above),
-     * all other attributes would be sanitized using the defaults in the switch statement below
-     *
-     * @param array $attributes
-     * @return array
-     */
-    private function sanitizeAttributes(array $attributes)
-    {
-        $custom_sanitization = $this->customAttributeSanitizationMap();
-        foreach ($attributes as $key => $value) {
-            // is a custom sanitization callback specified ?
-            if (isset($custom_sanitization[$key])) {
-                $callback = $custom_sanitization[$key];
-                if ($callback === 'skip_sanitization') {
-                    $attributes[$key] = $value;
-                    continue;
-                }
-                if (function_exists($callback)) {
-                    $attributes[$key] = $callback($value);
-                    continue;
-                }
-            }
-            switch (true) {
-                case $value === null :
-                case is_int($value) :
-                case is_float($value) :
-                    // typical booleans
-                case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
-                    $attributes[$key] = $value;
-                    break;
-                case is_string($value) :
-                    $attributes[$key] = sanitize_text_field($value);
-                    break;
-                case is_array($value) :
-                    $attributes[$key] = $this->sanitizeAttributes($value);
-                    break;
-                default :
-                    // only remaining data types are Object and Resource
-                    // which are not allowed as shortcode attributes
-                    $attributes[$key] = null;
-                    break;
-            }
-        }
-        return $attributes;
-    }
-
-
-
-    /**
-     * Returns whether or not this shortcode has been initialized
-     * @return boolean
-     */
-    public function initialized(){
-        return $this->initialized;
-    }
+	/**
+	 * transient prefix
+	 *
+	 * @type string
+	 */
+	const CACHE_TRANSIENT_PREFIX = 'ee_sc_';
+
+	/**
+	 * @var PostRelatedCacheManager $cache_manager
+	 */
+	private $cache_manager;
+
+	/**
+	 * true if ShortcodeInterface::initializeShortcode() has been called
+	 * if false, then that will get called before processing
+	 *
+	 * @var boolean $initialized
+	 */
+	private $initialized = false;
+
+
+
+	/**
+	 * EspressoShortcode constructor
+	 *
+	 * @param PostRelatedCacheManager $cache_manager
+	 */
+	public function __construct(PostRelatedCacheManager $cache_manager)
+	{
+		$this->cache_manager = $cache_manager;
+	}
+
+
+
+	/**
+	 * @return void
+	 */
+	public function shortcodeHasBeenInitialized()
+	{
+		$this->initialized = true;
+	}
+
+
+
+	/**
+	 * enqueues scripts then processes the shortcode
+	 *
+	 * @param array $attributes
+	 * @return string
+	 * @throws EE_Error
+	 */
+	final public function processShortcodeCallback($attributes = array())
+	{
+		if ($this instanceof EnqueueAssetsInterface) {
+			if (is_admin()) {
+				$this->enqueueAdminScripts();
+			} else {
+				$this->enqueueScripts();
+			}
+		}
+		return $this->shortcodeContent(
+			$this->sanitizeAttributes((array)$attributes)
+		);
+	}
+
+
+
+	/**
+	 * If shortcode caching is enabled for the shortcode,
+	 * and cached results exist, then that will be returned
+	 * else new content will be generated.
+	 * If caching is enabled, then the new content will be cached for later.
+	 *
+	 * @param array $attributes
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	private function shortcodeContent(array $attributes)
+	{
+		$shortcode = $this;
+		$post_ID = $this->currentPostID();
+		// something like "SC_EVENTS-123"
+		$cache_ID = $this->shortcodeCacheID($post_ID);
+		$this->cache_manager->clearPostRelatedCacheOnUpdate($post_ID, $cache_ID);
+		return $this->cache_manager->get(
+			$cache_ID,
+			// serialized attributes
+			wp_json_encode($attributes),
+			// Closure for generating content if cache is expired
+			function () use ($shortcode, $attributes) {
+				if($shortcode->initialized() === false){
+					$shortcode->initializeShortcode();
+				}
+				return $shortcode->processShortcode($attributes);
+			},
+			// filterable cache expiration set by each shortcode
+			apply_filters(
+				'FHEE__EventEspresso_core_services_shortcodes_EspressoShortcode__shortcodeContent__cache_expiration',
+				$this->cacheExpiration(),
+				$this->getTag(),
+				$this
+			)
+		);
+	}
+
+
+
+	/**
+	 * @return int
+	 * @throws EE_Error
+	 */
+	private function currentPostID()
+	{
+		// try to get EE_Event any way we can
+		$event = EEH_Event_View::get_event();
+		// then get some kind of ID
+		if ($event instanceof EE_Event) {
+			return $event->ID();
+		}
+		global $post;
+		if ($post instanceof EE_Event) {
+			return $post->ID();
+		}
+		if ($post instanceof WP_Post) {
+			return $post->ID;
+		}
+		return 0;
+	}
+
+
+
+	/**
+	 * @param int $post_ID
+	 * @return string
+	 * @throws EE_Error
+	 */
+	private function shortcodeCacheID($post_ID)
+	{
+		$tag = str_replace('ESPRESSO_', '', $this->getTag());
+		return "SC_{$tag}-{$post_ID}";
+	}
+
+
+
+	/**
+	 * array for defining custom attribute sanitization callbacks,
+	 * where keys match keys in your attributes array,
+	 * and values represent the sanitization function you wish to be applied to that attribute.
+	 * So for example, if you had an integer attribute named "event_id"
+	 * that you wanted to be sanitized using absint(),
+	 * then you would return the following:
+	 *      array('event_id' => 'absint')
+	 * Entering 'skip_sanitization' for the callback value
+	 * means that no sanitization will be applied
+	 * on the assumption that the attribute
+	 * will be sanitized at some point... right?
+	 * You wouldn't pass around unsanitized attributes would you?
+	 * That would be very Tom Foolery of you!!!
+	 *
+	 * @return array
+	 */
+	protected function customAttributeSanitizationMap()
+	{
+		return array();
+	}
+
+
+
+	/**
+	 * Performs basic sanitization on shortcode attributes
+	 * Since incoming attributes from the shortcode usage in the WP editor will all be strings,
+	 * most attributes will by default be sanitized using the sanitize_text_field() function.
+	 * This can be overridden using the customAttributeSanitizationMap() method (see above),
+	 * all other attributes would be sanitized using the defaults in the switch statement below
+	 *
+	 * @param array $attributes
+	 * @return array
+	 */
+	private function sanitizeAttributes(array $attributes)
+	{
+		$custom_sanitization = $this->customAttributeSanitizationMap();
+		foreach ($attributes as $key => $value) {
+			// is a custom sanitization callback specified ?
+			if (isset($custom_sanitization[$key])) {
+				$callback = $custom_sanitization[$key];
+				if ($callback === 'skip_sanitization') {
+					$attributes[$key] = $value;
+					continue;
+				}
+				if (function_exists($callback)) {
+					$attributes[$key] = $callback($value);
+					continue;
+				}
+			}
+			switch (true) {
+				case $value === null :
+				case is_int($value) :
+				case is_float($value) :
+					// typical booleans
+				case in_array($value, array(true, 'true', '1', 'on', 'yes', false, 'false', '0', 'off', 'no'), true) :
+					$attributes[$key] = $value;
+					break;
+				case is_string($value) :
+					$attributes[$key] = sanitize_text_field($value);
+					break;
+				case is_array($value) :
+					$attributes[$key] = $this->sanitizeAttributes($value);
+					break;
+				default :
+					// only remaining data types are Object and Resource
+					// which are not allowed as shortcode attributes
+					$attributes[$key] = null;
+					break;
+			}
+		}
+		return $attributes;
+	}
+
+
+
+	/**
+	 * Returns whether or not this shortcode has been initialized
+	 * @return boolean
+	 */
+	public function initialized(){
+		return $this->initialized;
+	}
 
 
 

Spacing +4 added lines, -4 removed lines

@@ -84,7 +84,7 @@ 
             }
         }
         return $this->shortcodeContent(
-            $this->sanitizeAttributes((array)$attributes)
+            $this->sanitizeAttributes((array) $attributes)
         );
     }
 
@@ -112,8 +112,8 @@ 
             // serialized attributes
             wp_json_encode($attributes),
             // Closure for generating content if cache is expired
-            function () use ($shortcode, $attributes) {
-                if($shortcode->initialized() === false){
+            function() use ($shortcode, $attributes) {
+                if ($shortcode->initialized() === false) {
                     $shortcode->initializeShortcode();
                 }
                 return $shortcode->processShortcode($attributes);
@@ -247,7 +247,7 @@ 
      * Returns whether or not this shortcode has been initialized
      * @return boolean
      */
-    public function initialized(){
+    public function initialized() {
         return $this->initialized;
     }
 

core/services/shortcodes/ShortcodeInterface.php

Indentation +46 added lines, -46 removed lines

@@ -8,52 +8,52 @@
 interface ShortcodeInterface
 {
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag();
-
-    /**
-     * the length of time in seconds to cache the results of the processShortcode() method
-     * 0 means the processShortcode() results will NOT be cached at all
-     *
-     * @return int
-     */
-    public function cacheExpiration();
-
-    /**
-     * a place for adding any initialization code that needs to run prior to wp_header().
-     * this may be required for shortcodes that utilize a corresponding module,
-     * and need to enqueue assets for that module
-     *
-     * !!! IMPORTANT !!!
-     * After performing any logic within this method required for initialization
-     *         $this->shortcodeHasBeenInitialized();
-     * should be called to ensure that the shortcode is setup correctly.
-     *
-     * @return void
-     */
-    public function initializeShortcode();
-
-    /**
-     * callback that runs when the shortcode is encountered in post content.
-     * IMPORTANT !!!
-     * remember that shortcode content should be RETURNED and NOT echoed out
-     *
-     * @param array $attributes
-     * @return string
-     */
-    public function processShortcode($attributes = array());
-
-
-
-    /**
-     * Returns whether or not this shortcode class has already been initialized
-     * @return boolean
-     */
-    public function initialized();
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag();
+
+	/**
+	 * the length of time in seconds to cache the results of the processShortcode() method
+	 * 0 means the processShortcode() results will NOT be cached at all
+	 *
+	 * @return int
+	 */
+	public function cacheExpiration();
+
+	/**
+	 * a place for adding any initialization code that needs to run prior to wp_header().
+	 * this may be required for shortcodes that utilize a corresponding module,
+	 * and need to enqueue assets for that module
+	 *
+	 * !!! IMPORTANT !!!
+	 * After performing any logic within this method required for initialization
+	 *         $this->shortcodeHasBeenInitialized();
+	 * should be called to ensure that the shortcode is setup correctly.
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode();
+
+	/**
+	 * callback that runs when the shortcode is encountered in post content.
+	 * IMPORTANT !!!
+	 * remember that shortcode content should be RETURNED and NOT echoed out
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	public function processShortcode($attributes = array());
+
+
+
+	/**
+	 * Returns whether or not this shortcode class has already been initialized
+	 * @return boolean
+	 */
+	public function initialized();
 
 }
 // End of file ShortcodeInterface.php