eventespresso / event-espresso-core

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +1221 added lines, -1221 removed lines

@@ -23,1225 +23,1225 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace = Domain::API_NAMESPACE;
-
-    const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
-
-    const saved_routes_option_names = 'ee_core_routes';
-
-    /**
-     * string used in _links response bodies to make them globally unique.
-     *
-     * @see http://v2.wp-api.org/extending/linking/
-     */
-    const ee_api_link_namespace = 'https://api.eventespresso.com/';
-
-    /**
-     * @var CalculatedModelFields
-     */
-    protected static $_field_calculator;
-
-
-    /**
-     * @return EED_Core_Rest_Api|EED_Module
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter(
-            'rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
-        );
-        EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
-    }
-
-
-    /**
-     * sets up hooks which only need to be included as part of REST API requests;
-     * other requests like to the frontend or admin etc don't need them
-     *
-     * @throws \EE_Error
-     */
-    public static function set_hooks_rest_api()
-    {
-        // set hooks which account for changes made to the API
-        EED_Core_Rest_Api::_set_hooks_for_changes();
-    }
-
-
-    /**
-     * public wrapper of _set_hooks_for_changes.
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     *
-     * @throws EE_Error
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            // ignore the base parent class
-            // and legacy named classes
-            if ($classname_in_namespace === 'ChangesInBase'
-                || strpos($classname_in_namespace, 'Changes_In_') === 0
-            ) {
-                continue;
-            }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
-            if (class_exists($full_classname)) {
-                $instance_of_class = new $full_classname;
-                if ($instance_of_class instanceof ChangesInBase) {
-                    $instance_of_class->setHooks();
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Filters the WP routes to add our EE-related ones. This takes a bit of time
-     * so we actually prefer to only do it when an EE plugin is activated or upgraded
-     *
-     * @throws \EE_Error
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
-            foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
-                /**
-                 * @var array     $data_for_multiple_endpoints numerically indexed array
-                 *                                         but can also contain route options like {
-                 * @type array    $schema                      {
-                 * @type callable $schema_callback
-                 * @type array    $callback_args               arguments that will be passed to the callback, after the
-                 * WP_REST_Request of course
-                 * }
-                 * }
-                 */
-                // when registering routes, register all the endpoints' data at the same time
-                $multiple_endpoint_args = array();
-                foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
-                    /**
-                     * @var array     $data_for_single_endpoint {
-                     * @type callable $callback
-                     * @type string methods
-                     * @type array args
-                     * @type array _links
-                     * @type array    $callback_args            arguments that will be passed to the callback, after the
-                     * WP_REST_Request of course
-                     * }
-                     */
-                    // skip route options
-                    if (! is_numeric($endpoint_key)) {
-                        continue;
-                    }
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
-                        throw new EE_Error(
-                            esc_html__(
-                            // @codingStandardsIgnoreStart
-                                'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            )
-                        );
-                    }
-                    $callback = $data_for_single_endpoint['callback'];
-                    $single_endpoint_args = array(
-                        'methods' => $data_for_single_endpoint['methods'],
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
-                            : array(),
-                    );
-                    if (isset($data_for_single_endpoint['_links'])) {
-                        $single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
-                    }
-                    if (isset($data_for_single_endpoint['callback_args'])) {
-                        $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
-                            $callback,
-                            $callback_args
-                        ) {
-                            array_unshift($callback_args, $request);
-                            return call_user_func_array(
-                                $callback,
-                                $callback_args
-                            );
-                        };
-                    } else {
-                        $single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
-                    }
-                    $multiple_endpoint_args[] = $single_endpoint_args;
-                }
-                if (isset($data_for_multiple_endpoints['schema'])) {
-                    $schema_route_data = $data_for_multiple_endpoints['schema'];
-                    $schema_callback = $schema_route_data['schema_callback'];
-                    $callback_args = $schema_route_data['callback_args'];
-                    $multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
-                        return call_user_func_array(
-                            $schema_callback,
-                            $callback_args
-                        );
-                    };
-                }
-                register_rest_route(
-                    $namespace,
-                    $relative_route,
-                    $multiple_endpoint_args
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Checks if there was a version change or something that merits invalidating the cached
-     * route data. If so, invalidates the cached route data so that it gets refreshed
-     * next time the WP API is used
-     */
-    public static function invalidate_cached_route_data_on_version_change()
-    {
-        if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
-            EED_Core_Rest_Api::invalidate_cached_route_data();
-        }
-        foreach (EE_Registry::instance()->addons as $addon) {
-            if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
-                EED_Core_Rest_Api::invalidate_cached_route_data();
-            }
-        }
-    }
-
-
-    /**
-     * Removes the cached route data so it will get refreshed next time the WP API is used
-     */
-    public static function invalidate_cached_route_data()
-    {
-        // delete the saved EE REST API routes
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
-            delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
-        }
-    }
-
-
-    /**
-     * Gets the EE route data
-     *
-     * @return array top-level key is the namespace, next-level key is the route and its value is array{
-     * @throws \EE_Error
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
-                $version,
-                $hidden_endpoints
-            );
-        }
-        return $ee_routes;
-    }
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     * @throws \EE_Error
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null
-     * @throws \EE_Error
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-    /**
-     * Calculates all the EE routes and saves it to a WordPress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[ EED_Core_Rest_Api::ee_api_namespace
-                           . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-    /**
-     * Decides whether or not to add write endpoints for this model.
-     *
-     * Currently, this defaults to exclude all global tables and models
-     * which would allow inserting WP core data (we don't want to duplicate
-     * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
-     *
-     * @param EEM_Base $model
-     * @return bool
-     */
-    public static function should_have_write_endpoints(EEM_Base $model)
-    {
-        if ($model->is_wp_core_model()) {
-            return false;
-        }
-        foreach ($model->get_tables() as $table) {
-            if ($table->is_global()) {
-                return false;
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
-     * in this versioned namespace of EE4
-     *
-     * @param $version
-     * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
-     */
-    public static function model_names_with_plural_routes($version)
-    {
-        $model_version_info = new ModelVersionInfo($version);
-        $models_to_register = $model_version_info->modelsForRequestedVersion();
-        // let's not bother having endpoints for extra metas
-        unset(
-            $models_to_register['Extra_Meta'],
-            $models_to_register['Extra_Join'],
-            $models_to_register['Post_Meta']
-        );
-        return apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $models_to_register
-        );
-    }
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_routes = array();
-        $model_version_info = new ModelVersionInfo($version);
-        foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
-            $model = \EE_Registry::instance()->load_model($model_name);
-            // if this isn't a valid model then let's skip iterate to the next item in the loop.
-            if (! $model instanceof EEM_Base) {
-                continue;
-            }
-            // yes we could just register one route for ALL models, but then they wouldn't show up in the index
-            $plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
-            $singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
-            $model_routes[ $plural_model_route ] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetAll',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                ),
-                'schema' => array(
-                    'schema_callback' => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleSchemaRequest',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                ),
-            );
-            $model_routes[ $singular_model_route ] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetOne',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-            );
-            if (apply_filters(
-                'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
-                EED_Core_Rest_Api::should_have_write_endpoints($model),
-                $model
-            )) {
-                $model_routes[ $plural_model_route ][] = array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                        'handleRequestInsert',
-                    ),
-                    'callback_args'   => array($version, $model_name),
-                    'methods'         => WP_REST_Server::CREATABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_write_params($model_name, $model_version_info, true),
-                );
-                $model_routes[ $singular_model_route ] = array_merge(
-                    $model_routes[ $singular_model_route ],
-                    array(
-                        array(
-                            'callback'        => array(
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestUpdate',
-                            ),
-                            'callback_args'   => array($version, $model_name),
-                            'methods'         => WP_REST_Server::EDITABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
-                        ),
-                        array(
-                            'callback'        => array(
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestDelete',
-                            ),
-                            'callback_args'   => array($version, $model_name),
-                            'methods'         => WP_REST_Server::DELETABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_delete_query_params($model, $version),
-                        ),
-                    )
-                );
-            }
-            foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-                $related_route = EED_Core_Rest_Api::get_relation_route_via(
-                    $model,
-                    '(?P<id>[^\/]+)',
-                    $relation_obj
-                );
-                $endpoints = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handleRequestGetRelated',
-                        ),
-                        'callback_args'   => array($version, $model_name, $relation_name),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                );
-                $model_routes[ $related_route ] = $endpoints;
-            }
-        }
-        return $model_routes;
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event') = 'events'
-     *
-     * @param EEM_Base $model
-     * @return string
-     */
-    public static function get_collection_route(EEM_Base $model)
-    {
-        return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base $model eg Event or Venue
-     * @param string   $id
-     * @return string
-     */
-    public static function get_entity_route($model, $id)
-    {
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
-    }
-
-
-    /**
-     * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
-     * excluding the preceding slash.
-     * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
-     *
-     * @param EEM_Base               $model eg Event or Venue
-     * @param string                 $id
-     * @param EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
-    {
-        $related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
-            $relation_obj->get_other_model()->get_this_model_name(),
-            $relation_obj
-        );
-        return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
-    }
-
-
-    /**
-     * Adds onto the $relative_route the EE4 REST API versioned namespace.
-     * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
-     *
-     * @param string $relative_route
-     * @param string $version
-     * @return string
-     */
-    public static function get_versioned_route_to($relative_route, $version = '4.8.36')
-    {
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
-    }
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $routes;
-    }
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        // checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handleRequestToggleCheckin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __(
-                        // @codingStandardsIgnoreStart
-                            'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            // @codingStandardsIgnoreEnd
-                            'event_espresso'
-                        ),
-                    ),
-                ),
-                'callback_args'   => array($version),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                    'type'     => 'string',
-                ),
-                'calculate' => array(
-                    'required'          => false,
-                    'default'           => '',
-                    'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
-                    'type'              => 'string',
-                    // because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-    /**
-     * Gets the parameters acceptable for delete requests
-     *
-     * @param \EEM_Base $model
-     * @param string    $version
-     * @return array
-     */
-    protected function _get_delete_query_params(\EEM_Base $model, $version)
-    {
-        $params_for_delete = array(
-            'allow_blocking' => array(
-                'required' => false,
-                'default'  => true,
-                'type'     => 'boolean',
-            ),
-        );
-        $params_for_delete['force'] = array(
-            'required' => false,
-            'default'  => false,
-            'type'     => 'boolean',
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
-            $params_for_delete,
-            $model,
-            $version
-        );
-    }
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required'          => false,
-                    'default'           => array(),
-                    'type'              => 'object',
-                    // because we accept an almost infinite list of possible where conditions, WP
-                    // core validation and sanitization freaks out. We'll just validate this argument
-                    // while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-                'limit'    => array(
-                    'required'          => false,
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
-                    'type'              => array(
-                        'array',
-                        'string',
-                        'integer',
-                    ),
-                    // because we accept a variety of types, WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-                'order_by' => array(
-                    'required'          => false,
-                    'default'           => $default_orderby,
-                    'type'              => array(
-                        'object',
-                        'string',
-                    ),// because we accept a variety of types, WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-                'group_by' => array(
-                    'required'          => false,
-                    'default'           => null,
-                    'type'              => array(
-                        'object',
-                        'string',
-                    ),
-                    // because we accept  an almost infinite list of possible groupings,
-                    // WP core validation and sanitization
-                    // freaks out. We'll just validate this argument while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-                'having'   => array(
-                    'required'          => false,
-                    'default'           => null,
-                    'type'              => 'object',
-                    // because we accept an almost infinite list of possible where conditions, WP
-                    // core validation and sanitization freaks out. We'll just validate this argument
-                    // while handling the request
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                    'type'     => 'string',
-                    'enum'     => array(
-                        EEM_Base::caps_read,
-                        EEM_Base::caps_read_admin,
-                        EEM_Base::caps_edit,
-                        EEM_Base::caps_delete,
-                    ),
-                ),
-            )
-        );
-    }
-
-
-    /**
-     * Gets parameter information for a model regarding writing data
-     *
-     * @param string           $model_name
-     * @param ModelVersionInfo $model_version_info
-     * @param boolean          $create                                       whether this is for request to create (in
-     *                                                                       which case we need all required params) or
-     *                                                                       just to update (in which case we don't
-     *                                                                       need those on every request)
-     * @return array
-     */
-    protected function _get_write_params(
-        $model_name,
-        ModelVersionInfo $model_version_info,
-        $create = false
-    ) {
-        $model = EE_Registry::instance()->load_model($model_name);
-        $fields = $model_version_info->fieldsOnModelInThisVersion($model);
-        $args_info = array();
-        foreach ($fields as $field_name => $field_obj) {
-            if ($field_obj->is_auto_increment()) {
-                // totally ignore auto increment IDs
-                continue;
-            }
-            $arg_info = $field_obj->getSchema();
-            $required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
-            $arg_info['required'] = $required;
-            // remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
-            unset($arg_info['readonly']);
-            $schema_properties = $field_obj->getSchemaProperties();
-            if (isset($schema_properties['raw'])
-                && $field_obj->getSchemaType() === 'object'
-            ) {
-                // if there's a "raw" form of this argument, use those properties instead
-                $arg_info = array_replace(
-                    $arg_info,
-                    $schema_properties['raw']
-                );
-            }
-            $arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $field_obj->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-            // we do our own validation and sanitization within the controller
-            if (function_exists('rest_validate_value_from_schema')) {
-                $sanitize_callback = array(
-                    'EED_Core_Rest_Api',
-                    'default_sanitize_callback',
-                );
-            } else {
-                $sanitize_callback = null;
-            }
-            $arg_info['sanitize_callback'] = $sanitize_callback;
-            $args_info[ $field_name ] = $arg_info;
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $gmt_arg_info = $arg_info;
-                $gmt_arg_info['description'] = sprintf(
-                    esc_html__(
-                        '%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_nicename(),
-                    $field_name
-                );
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
-            }
-        }
-        return $args_info;
-    }
-
-
-    /**
-     * Replacement for WP API's 'rest_parse_request_arg'.
-     * If the value is blank but not required, don't bother validating it.
-     * Also, it uses our email validation instead of WP API's default.
-     *
-     * @param                 $value
-     * @param WP_REST_Request $request
-     * @param                 $param
-     * @return bool|true|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
-    {
-        $attributes = $request->get_attributes();
-        if (! isset($attributes['args'][ $param ])
-            || ! is_array($attributes['args'][ $param ])) {
-            $validation_result = true;
-        } else {
-            $args = $attributes['args'][ $param ];
-            if ((
-                    $value === ''
-                    || $value === null
-                )
-                && (! isset($args['required'])
-                    || $args['required'] === false
-                )
-            ) {
-                // not required and not provided? that's cool
-                $validation_result = true;
-            } elseif (isset($args['format'])
-                      && $args['format'] === 'email'
-            ) {
-                $validation_result = true;
-                if (! self::_validate_email($value)) {
-                    $validation_result = new WP_Error(
-                        'rest_invalid_param',
-                        esc_html__(
-                            'The email address is not valid or does not exist.',
-                            'event_espresso'
-                        )
-                    );
-                }
-            } else {
-                $validation_result = rest_validate_value_from_schema($value, $args, $param);
-            }
-        }
-        if (is_wp_error($validation_result)) {
-            return $validation_result;
-        }
-        return rest_sanitize_request_arg($value, $request, $param);
-    }
-
-
-    /**
-     * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
-     *
-     * @param $email
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected static function _validate_email($email)
-    {
-        try {
-            EmailAddressFactory::create($email);
-            return true;
-        } catch (EmailValidationException $e) {
-            return false;
-        }
-    }
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $config_routes;
-    }
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequest',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequestSiteInfo',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
-                $version,
-                $hidden_endpoint
-            );
-        }
-        return $meta_routes;
-    }
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handleRequestModelsMeta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => array($version),
-                ),
-            ),
-        );
-    }
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     * @throws \EE_Error
-     */
-    public static function hide_old_endpoints($route_data)
-    {
-        // allow API clients to override which endpoints get hidden, in case
-        // they want to discover particular endpoints
-        // also, we don't have access to the request so we have to just grab it from the superglobal
-        $force_show_ee_namespace = ltrim(
-            EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
-            '/'
-        );
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $resource_name => $endpoints) {
-                foreach ($endpoints as $key => $endpoint) {
-                    // skip schema and other route options
-                    if (! is_numeric($key)) {
-                        continue;
-                    }
-                    // by default, hide "hidden_endpoint"s, unless the request indicates
-                    // to $force_show_ee_namespace, in which case only show that one
-                    // namespace's endpoints (and hide all others)
-                    if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                        || ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/');
-                        $full_route .= '/' . ltrim($resource_name, '/');
-                        unset($route_data[ $full_route ]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        // for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            // if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint === $latest_version) {
-                // don't hide the latest version in the index
-                $versions_served[ $key_versioned_endpoint ] = false;
-            } elseif ($key_versioned_endpoint >= $lowest_compatible_version
-                && $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-            ) {
-                // include, but hide, previous versions which are still supported
-                $versions_served[ $key_versioned_endpoint ] = true;
-            } elseif (apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )) {
-                // if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[ $key_versioned_endpoint ] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__core_version',
-            implode(
-                '.',
-                array_slice(
-                    explode(
-                        '.',
-                        espresso_version()
-                    ),
-                    0,
-                    3
-                )
-            )
-        );
-    }
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        // we actually don't use a const because we want folks to always use
-        // this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	const ee_api_namespace = Domain::API_NAMESPACE;
+
+	const ee_api_namespace_for_regex = 'ee\/v([^/]*)\/';
+
+	const saved_routes_option_names = 'ee_core_routes';
+
+	/**
+	 * string used in _links response bodies to make them globally unique.
+	 *
+	 * @see http://v2.wp-api.org/extending/linking/
+	 */
+	const ee_api_link_namespace = 'https://api.eventespresso.com/';
+
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected static $_field_calculator;
+
+
+	/**
+	 * @return EED_Core_Rest_Api|EED_Module
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = LoaderFactory::getLoader()->load('EventEspresso\core\libraries\rest_api\CalculatedModelFields');
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter(
+			'rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex')
+		);
+		EED_Core_Rest_Api::invalidate_cached_route_data_on_version_change();
+	}
+
+
+	/**
+	 * sets up hooks which only need to be included as part of REST API requests;
+	 * other requests like to the frontend or admin etc don't need them
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function set_hooks_rest_api()
+	{
+		// set hooks which account for changes made to the API
+		EED_Core_Rest_Api::_set_hooks_for_changes();
+	}
+
+
+	/**
+	 * public wrapper of _set_hooks_for_changes.
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 *
+	 * @throws EE_Error
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			// ignore the base parent class
+			// and legacy named classes
+			if ($classname_in_namespace === 'ChangesInBase'
+				|| strpos($classname_in_namespace, 'Changes_In_') === 0
+			) {
+				continue;
+			}
+			$full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+			if (class_exists($full_classname)) {
+				$instance_of_class = new $full_classname;
+				if ($instance_of_class instanceof ChangesInBase) {
+					$instance_of_class->setHooks();
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Filters the WP routes to add our EE-related ones. This takes a bit of time
+	 * so we actually prefer to only do it when an EE plugin is activated or upgraded
+	 *
+	 * @throws \EE_Error
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_routes) {
+			foreach ($relative_routes as $relative_route => $data_for_multiple_endpoints) {
+				/**
+				 * @var array     $data_for_multiple_endpoints numerically indexed array
+				 *                                         but can also contain route options like {
+				 * @type array    $schema                      {
+				 * @type callable $schema_callback
+				 * @type array    $callback_args               arguments that will be passed to the callback, after the
+				 * WP_REST_Request of course
+				 * }
+				 * }
+				 */
+				// when registering routes, register all the endpoints' data at the same time
+				$multiple_endpoint_args = array();
+				foreach ($data_for_multiple_endpoints as $endpoint_key => $data_for_single_endpoint) {
+					/**
+					 * @var array     $data_for_single_endpoint {
+					 * @type callable $callback
+					 * @type string methods
+					 * @type array args
+					 * @type array _links
+					 * @type array    $callback_args            arguments that will be passed to the callback, after the
+					 * WP_REST_Request of course
+					 * }
+					 */
+					// skip route options
+					if (! is_numeric($endpoint_key)) {
+						continue;
+					}
+					if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
+						throw new EE_Error(
+							esc_html__(
+							// @codingStandardsIgnoreStart
+								'Endpoint configuration data needs to have entries "callback" (callable) and "methods" (comma-separated list of accepts HTTP methods).',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							)
+						);
+					}
+					$callback = $data_for_single_endpoint['callback'];
+					$single_endpoint_args = array(
+						'methods' => $data_for_single_endpoint['methods'],
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
+							: array(),
+					);
+					if (isset($data_for_single_endpoint['_links'])) {
+						$single_endpoint_args['_links'] = $data_for_single_endpoint['_links'];
+					}
+					if (isset($data_for_single_endpoint['callback_args'])) {
+						$callback_args = $data_for_single_endpoint['callback_args'];
+						$single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
+							$callback,
+							$callback_args
+						) {
+							array_unshift($callback_args, $request);
+							return call_user_func_array(
+								$callback,
+								$callback_args
+							);
+						};
+					} else {
+						$single_endpoint_args['callback'] = $data_for_single_endpoint['callback'];
+					}
+					$multiple_endpoint_args[] = $single_endpoint_args;
+				}
+				if (isset($data_for_multiple_endpoints['schema'])) {
+					$schema_route_data = $data_for_multiple_endpoints['schema'];
+					$schema_callback = $schema_route_data['schema_callback'];
+					$callback_args = $schema_route_data['callback_args'];
+					$multiple_endpoint_args['schema'] = function () use ($schema_callback, $callback_args) {
+						return call_user_func_array(
+							$schema_callback,
+							$callback_args
+						);
+					};
+				}
+				register_rest_route(
+					$namespace,
+					$relative_route,
+					$multiple_endpoint_args
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Checks if there was a version change or something that merits invalidating the cached
+	 * route data. If so, invalidates the cached route data so that it gets refreshed
+	 * next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data_on_version_change()
+	{
+		if (EE_System::instance()->detect_req_type() !== EE_System::req_type_normal) {
+			EED_Core_Rest_Api::invalidate_cached_route_data();
+		}
+		foreach (EE_Registry::instance()->addons as $addon) {
+			if ($addon instanceof EE_Addon && $addon->detect_req_type() !== EE_System::req_type_normal) {
+				EED_Core_Rest_Api::invalidate_cached_route_data();
+			}
+		}
+	}
+
+
+	/**
+	 * Removes the cached route data so it will get refreshed next time the WP API is used
+	 */
+	public static function invalidate_cached_route_data()
+	{
+		// delete the saved EE REST API routes
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden) {
+			delete_option(EED_Core_Rest_Api::saved_routes_option_names . $version);
+		}
+	}
+
+
+	/**
+	 * Gets the EE route data
+	 *
+	 * @return array top-level key is the namespace, next-level key is the route and its value is array{
+	 * @throws \EE_Error
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[ self::ee_api_namespace . $version ] = self::_get_ee_route_data_for_version(
+				$version,
+				$hidden_endpoints
+			);
+		}
+		return $ee_routes;
+	}
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if (! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null
+	 * @throws \EE_Error
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a WordPress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[ EED_Core_Rest_Api::ee_api_namespace
+						   . $version ] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+	/**
+	 * Decides whether or not to add write endpoints for this model.
+	 *
+	 * Currently, this defaults to exclude all global tables and models
+	 * which would allow inserting WP core data (we don't want to duplicate
+	 * what WP API does, as it's unnecessary, extra work, and potentially extra bugs)
+	 *
+	 * @param EEM_Base $model
+	 * @return bool
+	 */
+	public static function should_have_write_endpoints(EEM_Base $model)
+	{
+		if ($model->is_wp_core_model()) {
+			return false;
+		}
+		foreach ($model->get_tables() as $table) {
+			if ($table->is_global()) {
+				return false;
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * Gets the names of all models which should have plural routes (eg `ee/v4.8.36/events`)
+	 * in this versioned namespace of EE4
+	 *
+	 * @param $version
+	 * @return array keys are model names (eg 'Event') and values ar either classnames (eg 'EEM_Event')
+	 */
+	public static function model_names_with_plural_routes($version)
+	{
+		$model_version_info = new ModelVersionInfo($version);
+		$models_to_register = $model_version_info->modelsForRequestedVersion();
+		// let's not bother having endpoints for extra metas
+		unset(
+			$models_to_register['Extra_Meta'],
+			$models_to_register['Extra_Join'],
+			$models_to_register['Post_Meta']
+		);
+		return apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$models_to_register
+		);
+	}
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_routes = array();
+		$model_version_info = new ModelVersionInfo($version);
+		foreach (EED_Core_Rest_Api::model_names_with_plural_routes($version) as $model_name => $model_classname) {
+			$model = \EE_Registry::instance()->load_model($model_name);
+			// if this isn't a valid model then let's skip iterate to the next item in the loop.
+			if (! $model instanceof EEM_Base) {
+				continue;
+			}
+			// yes we could just register one route for ALL models, but then they wouldn't show up in the index
+			$plural_model_route = EED_Core_Rest_Api::get_collection_route($model);
+			$singular_model_route = EED_Core_Rest_Api::get_entity_route($model, '(?P<id>[^\/]+)');
+			$model_routes[ $plural_model_route ] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetAll',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+				),
+				'schema' => array(
+					'schema_callback' => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleSchemaRequest',
+					),
+					'callback_args'   => array($version, $model_name),
+				),
+			);
+			$model_routes[ $singular_model_route ] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetOne',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+			);
+			if (apply_filters(
+				'FHEE__EED_Core_Rest_Api___get_model_route_data_for_version__add_write_endpoints',
+				EED_Core_Rest_Api::should_have_write_endpoints($model),
+				$model
+			)) {
+				$model_routes[ $plural_model_route ][] = array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+						'handleRequestInsert',
+					),
+					'callback_args'   => array($version, $model_name),
+					'methods'         => WP_REST_Server::CREATABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_write_params($model_name, $model_version_info, true),
+				);
+				$model_routes[ $singular_model_route ] = array_merge(
+					$model_routes[ $singular_model_route ],
+					array(
+						array(
+							'callback'        => array(
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestUpdate',
+							),
+							'callback_args'   => array($version, $model_name),
+							'methods'         => WP_REST_Server::EDITABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
+						),
+						array(
+							'callback'        => array(
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestDelete',
+							),
+							'callback_args'   => array($version, $model_name),
+							'methods'         => WP_REST_Server::DELETABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_delete_query_params($model, $version),
+						),
+					)
+				);
+			}
+			foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+				$related_route = EED_Core_Rest_Api::get_relation_route_via(
+					$model,
+					'(?P<id>[^\/]+)',
+					$relation_obj
+				);
+				$endpoints = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handleRequestGetRelated',
+						),
+						'callback_args'   => array($version, $model_name, $relation_name),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+				);
+				$model_routes[ $related_route ] = $endpoints;
+			}
+		}
+		return $model_routes;
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API plural route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event') = 'events'
+	 *
+	 * @param EEM_Base $model
+	 * @return string
+	 */
+	public static function get_collection_route(EEM_Base $model)
+	{
+		return EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base $model eg Event or Venue
+	 * @param string   $id
+	 * @return string
+	 */
+	public static function get_entity_route($model, $id)
+	{
+		return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
+	}
+
+
+	/**
+	 * Gets the relative URI to a model's REST API singular route, after the EE4 versioned namespace,
+	 * excluding the preceding slash.
+	 * Eg you pass get_plural_route_to('Event', 12) = 'events/12'
+	 *
+	 * @param EEM_Base               $model eg Event or Venue
+	 * @param string                 $id
+	 * @param EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function get_relation_route_via(EEM_Base $model, $id, EE_Model_Relation_Base $relation_obj)
+	{
+		$related_model_name_endpoint_part = ModelRead::getRelatedEntityName(
+			$relation_obj->get_other_model()->get_this_model_name(),
+			$relation_obj
+		);
+		return EED_Core_Rest_Api::get_entity_route($model, $id) . '/' . $related_model_name_endpoint_part;
+	}
+
+
+	/**
+	 * Adds onto the $relative_route the EE4 REST API versioned namespace.
+	 * Eg if given '4.8.36' and 'events', will return 'ee/v4.8.36/events'
+	 *
+	 * @param string $relative_route
+	 * @param string $version
+	 * @return string
+	 */
+	public static function get_versioned_route_to($relative_route, $version = '4.8.36')
+	{
+		return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
+	}
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $routes;
+	}
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		// checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handleRequestToggleCheckin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __(
+						// @codingStandardsIgnoreStart
+							'Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							// @codingStandardsIgnoreEnd
+							'event_espresso'
+						),
+					),
+				),
+				'callback_args'   => array($version),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+					'type'     => 'string',
+				),
+				'calculate' => array(
+					'required'          => false,
+					'default'           => '',
+					'enum'              => self::$_field_calculator->retrieveCalculatedFieldsForModel($model),
+					'type'              => 'string',
+					// because we accept a CSV'd list of the enumerated strings, WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+	/**
+	 * Gets the parameters acceptable for delete requests
+	 *
+	 * @param \EEM_Base $model
+	 * @param string    $version
+	 * @return array
+	 */
+	protected function _get_delete_query_params(\EEM_Base $model, $version)
+	{
+		$params_for_delete = array(
+			'allow_blocking' => array(
+				'required' => false,
+				'default'  => true,
+				'type'     => 'boolean',
+			),
+		);
+		$params_for_delete['force'] = array(
+			'required' => false,
+			'default'  => false,
+			'type'     => 'boolean',
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
+			$params_for_delete,
+			$model,
+			$version
+		);
+	}
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[ $key_field->get_name() ] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required'          => false,
+					'default'           => array(),
+					'type'              => 'object',
+					// because we accept an almost infinite list of possible where conditions, WP
+					// core validation and sanitization freaks out. We'll just validate this argument
+					// while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+				'limit'    => array(
+					'required'          => false,
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
+					'type'              => array(
+						'array',
+						'string',
+						'integer',
+					),
+					// because we accept a variety of types, WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+				'order_by' => array(
+					'required'          => false,
+					'default'           => $default_orderby,
+					'type'              => array(
+						'object',
+						'string',
+					),// because we accept a variety of types, WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+				'group_by' => array(
+					'required'          => false,
+					'default'           => null,
+					'type'              => array(
+						'object',
+						'string',
+					),
+					// because we accept  an almost infinite list of possible groupings,
+					// WP core validation and sanitization
+					// freaks out. We'll just validate this argument while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+				'having'   => array(
+					'required'          => false,
+					'default'           => null,
+					'type'              => 'object',
+					// because we accept an almost infinite list of possible where conditions, WP
+					// core validation and sanitization freaks out. We'll just validate this argument
+					// while handling the request
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+					'type'     => 'string',
+					'enum'     => array(
+						EEM_Base::caps_read,
+						EEM_Base::caps_read_admin,
+						EEM_Base::caps_edit,
+						EEM_Base::caps_delete,
+					),
+				),
+			)
+		);
+	}
+
+
+	/**
+	 * Gets parameter information for a model regarding writing data
+	 *
+	 * @param string           $model_name
+	 * @param ModelVersionInfo $model_version_info
+	 * @param boolean          $create                                       whether this is for request to create (in
+	 *                                                                       which case we need all required params) or
+	 *                                                                       just to update (in which case we don't
+	 *                                                                       need those on every request)
+	 * @return array
+	 */
+	protected function _get_write_params(
+		$model_name,
+		ModelVersionInfo $model_version_info,
+		$create = false
+	) {
+		$model = EE_Registry::instance()->load_model($model_name);
+		$fields = $model_version_info->fieldsOnModelInThisVersion($model);
+		$args_info = array();
+		foreach ($fields as $field_name => $field_obj) {
+			if ($field_obj->is_auto_increment()) {
+				// totally ignore auto increment IDs
+				continue;
+			}
+			$arg_info = $field_obj->getSchema();
+			$required = $create && ! $field_obj->is_nullable() && $field_obj->get_default_value() === null;
+			$arg_info['required'] = $required;
+			// remove the read-only flag. If it were read-only we wouldn't list it as an argument while writing, right?
+			unset($arg_info['readonly']);
+			$schema_properties = $field_obj->getSchemaProperties();
+			if (isset($schema_properties['raw'])
+				&& $field_obj->getSchemaType() === 'object'
+			) {
+				// if there's a "raw" form of this argument, use those properties instead
+				$arg_info = array_replace(
+					$arg_info,
+					$schema_properties['raw']
+				);
+			}
+			$arg_info['default'] = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$field_obj->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+			// we do our own validation and sanitization within the controller
+			if (function_exists('rest_validate_value_from_schema')) {
+				$sanitize_callback = array(
+					'EED_Core_Rest_Api',
+					'default_sanitize_callback',
+				);
+			} else {
+				$sanitize_callback = null;
+			}
+			$arg_info['sanitize_callback'] = $sanitize_callback;
+			$args_info[ $field_name ] = $arg_info;
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$gmt_arg_info = $arg_info;
+				$gmt_arg_info['description'] = sprintf(
+					esc_html__(
+						'%1$s - the value for this field in UTC. Ignored if %2$s is provided.',
+						'event_espresso'
+					),
+					$field_obj->get_nicename(),
+					$field_name
+				);
+				$args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
+			}
+		}
+		return $args_info;
+	}
+
+
+	/**
+	 * Replacement for WP API's 'rest_parse_request_arg'.
+	 * If the value is blank but not required, don't bother validating it.
+	 * Also, it uses our email validation instead of WP API's default.
+	 *
+	 * @param                 $value
+	 * @param WP_REST_Request $request
+	 * @param                 $param
+	 * @return bool|true|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	public static function default_sanitize_callback($value, WP_REST_Request $request, $param)
+	{
+		$attributes = $request->get_attributes();
+		if (! isset($attributes['args'][ $param ])
+			|| ! is_array($attributes['args'][ $param ])) {
+			$validation_result = true;
+		} else {
+			$args = $attributes['args'][ $param ];
+			if ((
+					$value === ''
+					|| $value === null
+				)
+				&& (! isset($args['required'])
+					|| $args['required'] === false
+				)
+			) {
+				// not required and not provided? that's cool
+				$validation_result = true;
+			} elseif (isset($args['format'])
+					  && $args['format'] === 'email'
+			) {
+				$validation_result = true;
+				if (! self::_validate_email($value)) {
+					$validation_result = new WP_Error(
+						'rest_invalid_param',
+						esc_html__(
+							'The email address is not valid or does not exist.',
+							'event_espresso'
+						)
+					);
+				}
+			} else {
+				$validation_result = rest_validate_value_from_schema($value, $args, $param);
+			}
+		}
+		if (is_wp_error($validation_result)) {
+			return $validation_result;
+		}
+		return rest_sanitize_request_arg($value, $request, $param);
+	}
+
+
+	/**
+	 * Returns whether or not this email address is valid. Copied from EE_Email_Validation_Strategy::_validate_email()
+	 *
+	 * @param $email
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected static function _validate_email($email)
+	{
+		try {
+			EmailAddressFactory::create($email);
+			return true;
+		} catch (EmailValidationException $e) {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[ self::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $config_routes;
+	}
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequest',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequestSiteInfo',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[ self::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
+				$version,
+				$hidden_endpoint
+			);
+		}
+		return $meta_routes;
+	}
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handleRequestModelsMeta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => array($version),
+				),
+			),
+		);
+	}
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 * @throws \EE_Error
+	 */
+	public static function hide_old_endpoints($route_data)
+	{
+		// allow API clients to override which endpoints get hidden, in case
+		// they want to discover particular endpoints
+		// also, we don't have access to the request so we have to just grab it from the superglobal
+		$force_show_ee_namespace = ltrim(
+			EEH_Array::is_set($_REQUEST, 'force_show_ee_namespace', ''),
+			'/'
+		);
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $resource_name => $endpoints) {
+				foreach ($endpoints as $key => $endpoint) {
+					// skip schema and other route options
+					if (! is_numeric($key)) {
+						continue;
+					}
+					// by default, hide "hidden_endpoint"s, unless the request indicates
+					// to $force_show_ee_namespace, in which case only show that one
+					// namespace's endpoints (and hide all others)
+					if (($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+						|| ($endpoint['hidden_endpoint'] && $force_show_ee_namespace === '')
+					) {
+						$full_route = '/' . ltrim($namespace, '/');
+						$full_route .= '/' . ltrim($resource_name, '/');
+						unset($route_data[ $full_route ]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		// for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			// if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint === $latest_version) {
+				// don't hide the latest version in the index
+				$versions_served[ $key_versioned_endpoint ] = false;
+			} elseif ($key_versioned_endpoint >= $lowest_compatible_version
+				&& $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+			) {
+				// include, but hide, previous versions which are still supported
+				$versions_served[ $key_versioned_endpoint ] = true;
+			} elseif (apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)) {
+				// if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[ $key_versioned_endpoint ] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__core_version',
+			implode(
+				'.',
+				array_slice(
+					explode(
+						'.',
+						espresso_version()
+					),
+					0,
+					3
+				)
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		// we actually don't use a const because we want folks to always use
+		// this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

core/libraries/rest_api/calculations/CalculatedModelFieldsFactory.php

Spacing +2 added lines, -2 removed lines

@@ -40,7 +40,7 @@ 
      */
     public function createFromModel($model_name)
     {
-        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
+        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\'.$model_name);
     }
 
     /**
@@ -51,7 +51,7 @@ 
     public function createFromClassname($calculator_classname)
     {
         $calculator = $this->loader->getShared($calculator_classname);
-        if (!$calculator instanceof Base) {
+        if ( ! $calculator instanceof Base) {
             throw new UnexpectedEntityException(
                 $calculator_classname,
                 'EventEspresso\core\libraries\rest_api\calculations\Base'

Indentation +37 added lines, -37 removed lines

@@ -18,46 +18,46 @@
  */
 class CalculatedModelFieldsFactory
 {
-    private $loader;
+	private $loader;
 
-    /**
-     * CalculatedModelFieldsFactory constructor.
-     * @param LoaderInterface $loader
-     */
-    public function __construct(LoaderInterface $loader)
-    {
-        $this->loader = $loader;
-    }
+	/**
+	 * CalculatedModelFieldsFactory constructor.
+	 * @param LoaderInterface $loader
+	 */
+	public function __construct(LoaderInterface $loader)
+	{
+		$this->loader = $loader;
+	}
 
-    /**
-     * Creates the calculator class that corresponds to that particular model
-     * @since 4.9.68.p
-     * @param string $model_name
-     * @return Base
-     * @throws UnexpectedEntityException
-     */
-    public function createFromModel($model_name)
-    {
-        return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
-    }
+	/**
+	 * Creates the calculator class that corresponds to that particular model
+	 * @since 4.9.68.p
+	 * @param string $model_name
+	 * @return Base
+	 * @throws UnexpectedEntityException
+	 */
+	public function createFromModel($model_name)
+	{
+		return $this->createFromClassname('EventEspresso\core\libraries\rest_api\calculations\\' . $model_name);
+	}
 
-    /**
-     * Creates the calculator class that corresponds to that classname and verifies it's of the correct type
-     * @param string $calculator_classname
-     * @return Base
-     * @throws UnexpectedEntityException
-     */
-    public function createFromClassname($calculator_classname)
-    {
-        $calculator = $this->loader->getShared($calculator_classname);
-        if (!$calculator instanceof Base) {
-            throw new UnexpectedEntityException(
-                $calculator_classname,
-                'EventEspresso\core\libraries\rest_api\calculations\Base'
-            );
-        }
-        return $calculator;
-    }
+	/**
+	 * Creates the calculator class that corresponds to that classname and verifies it's of the correct type
+	 * @param string $calculator_classname
+	 * @return Base
+	 * @throws UnexpectedEntityException
+	 */
+	public function createFromClassname($calculator_classname)
+	{
+		$calculator = $this->loader->getShared($calculator_classname);
+		if (!$calculator instanceof Base) {
+			throw new UnexpectedEntityException(
+				$calculator_classname,
+				'EventEspresso\core\libraries\rest_api\calculations\Base'
+			);
+		}
+		return $calculator;
+	}
 }
 // End of file CalculationsFactory.php
 // Location: EventEspresso\core\libraries\rest_api\calculations/CalculationsFactory.php

core/libraries/rest_api/calculations/Datetime.php

Spacing +3 added lines, -3 removed lines

@@ -87,7 +87,7 @@ 
      */
     public function registrationsCheckedInCount($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -121,7 +121,7 @@ 
      */
     public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -156,7 +156,7 @@ 
      */
     public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new EE_Error(
                 sprintf(
                     __(

Indentation +196 added lines, -196 removed lines

@@ -17,210 +17,210 @@
 
 class Datetime extends DatetimeCalculationBase
 {
-    /**
-     * @var EEM_Datetime
-     */
-    protected $datetime_model;
+	/**
+	 * @var EEM_Datetime
+	 */
+	protected $datetime_model;
 
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
-    public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
-    {
-        $this->datetime_model = $datetime_model;
-        $this->registration_model = $registration_model;
-    }
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
+	public function __construct(EEM_Datetime $datetime_model, EEM_Registration $registration_model)
+	{
+		$this->datetime_model = $datetime_model;
+		$this->registration_model = $registration_model;
+	}
 
-    /**
-     * Calculates the total spaces available on the datetime, taking into account
-     * ticket limits too.
-     *
-     * @see EE_Datetime::spaces_remaining( true )
-     * @param array            $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase  $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
-            $dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
-        } else {
-            $dtt_obj = null;
-        }
-        if ($dtt_obj instanceof EE_Datetime) {
-            return $dtt_obj->spaces_remaining(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Datetime.DTT_ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
+	/**
+	 * Calculates the total spaces available on the datetime, taking into account
+	 * ticket limits too.
+	 *
+	 * @see EE_Datetime::spaces_remaining( true )
+	 * @param array            $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase  $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function spacesRemainingConsideringTickets($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
+			$dtt_obj = $this->datetime_model->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
+		} else {
+			$dtt_obj = null;
+		}
+		if ($dtt_obj instanceof EE_Datetime) {
+			return $dtt_obj->spaces_remaining(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Datetime.DTT_ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
 
 
-    /**
-     * Counts registrations who have checked into this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
-    }
+	/**
+	 * Counts registrations who have checked into this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
+	}
 
 
-    /**
-     * Counts registrations who have checked out of this datetime
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return $this->registration_model
-                               ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
-    }
+	/**
+	 * Counts registrations who have checked out of this datetime
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return $this->registration_model
+							   ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
+	}
 
 
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $request
-     * @param DatetimeControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return $this->registration_model->count(
-            array(
-                array(
-                    'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
-                    'STS_ID'                 => EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $request
+	 * @param DatetimeControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return $this->registration_model->count(
+			array(
+				array(
+					'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
+					'STS_ID'                 => EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 
 
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        return array(
-            'spaces_remaining_considering_tickets' => array(
-                'description' => esc_html__(
-                    'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
-                    'event_espresso'
-                ),
-                'type' => 'number'
-            ),
-            'registrations_checked_in_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked into this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number'
-            ),
-            'registrations_checked_out_count' => array(
-                'description' => esc_html__(
-                    'Counts registrations who have checked out of this datetime.',
-                    'event_espresso'
-                ),
-                'type' => 'number'
-            ),
-            'spots_taken_pending_payment' => array(
-                'description' => esc_html__(
-                    'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
-                    'event_espresso'
-                ),
-                'type' => 'number'
-            ),
-        );
-    }
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		return array(
+			'spaces_remaining_considering_tickets' => array(
+				'description' => esc_html__(
+					'Calculates the total spaces available on the datetime, taking into account ticket limits too.',
+					'event_espresso'
+				),
+				'type' => 'number'
+			),
+			'registrations_checked_in_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked into this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number'
+			),
+			'registrations_checked_out_count' => array(
+				'description' => esc_html__(
+					'Counts registrations who have checked out of this datetime.',
+					'event_espresso'
+				),
+				'type' => 'number'
+			),
+			'spots_taken_pending_payment' => array(
+				'description' => esc_html__(
+					'The count of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for',
+					'event_espresso'
+				),
+				'type' => 'number'
+			),
+		);
+	}
 }

core/libraries/rest_api/calculations/Base.php

Spacing +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      */
     protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
     {
-        if (! current_user_can($required_permission)) {
+        if ( ! current_user_can($required_permission)) {
             throw new RestException(
                 'permission_denied',
                 sprintf(
@@ -75,6 +75,6 @@ 
     public function schemaForCalculation($calculation_index)
     {
         $schema_map = $this->schemaForCalculations();
-        return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
+        return isset($schema_map[$calculation_index]) ? $schema_map[$calculation_index] : array();
     }
 }

Indentation +57 added lines, -57 removed lines

@@ -16,65 +16,65 @@
 class Base
 {
 
-    /**
-     * @param $required_permission
-     * @param $attempted_calculation
-     * @throws RestException
-     */
-    protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
-    {
-        if (! current_user_can($required_permission)) {
-            throw new RestException(
-                'permission_denied',
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $attempted_calculation,
-                    EEH_Inflector::pluralize_and_lower($this->getResourceName()),
-                    $required_permission
-                )
-            );
-        }
-    }
+	/**
+	 * @param $required_permission
+	 * @param $attempted_calculation
+	 * @throws RestException
+	 */
+	protected function verifyCurrentUserCan($required_permission, $attempted_calculation)
+	{
+		if (! current_user_can($required_permission)) {
+			throw new RestException(
+				'permission_denied',
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$attempted_calculation,
+					EEH_Inflector::pluralize_and_lower($this->getResourceName()),
+					$required_permission
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Gets the name of the resource of the called class
-     *
-     * @return string
-     */
-    public function getResourceName()
-    {
-        return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1);
-    }
+	/**
+	 * Gets the name of the resource of the called class
+	 *
+	 * @return string
+	 */
+	public function getResourceName()
+	{
+		return substr(__CLASS__, strrpos(__CLASS__, '\\') + 1);
+	}
 
-    /**
-     * Returns an array to be used for the schema for the calculated fields.
-     * @since 4.9.68.p
-     * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays {
-     * @type string $description
-     * @type string $type, eg "string", "int", "boolean", "object", "array", etc
-     * }
-     */
-    public function schemaForCalculations()
-    {
-        return array();
-    }
+	/**
+	 * Returns an array to be used for the schema for the calculated fields.
+	 * @since 4.9.68.p
+	 * @return array keys are calculated field names (eg "optimum_sales_at_start") values are arrays {
+	 * @type string $description
+	 * @type string $type, eg "string", "int", "boolean", "object", "array", etc
+	 * }
+	 */
+	public function schemaForCalculations()
+	{
+		return array();
+	}
 
-    /**
-     * Returns the json schema for the given calculation index.
-     *
-     * @since 4.9.68.p
-     * @param $calculation_index
-     * @return array
-     */
-    public function schemaForCalculation($calculation_index)
-    {
-        $schema_map = $this->schemaForCalculations();
-        return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
-    }
+	/**
+	 * Returns the json schema for the given calculation index.
+	 *
+	 * @since 4.9.68.p
+	 * @param $calculation_index
+	 * @return array
+	 */
+	public function schemaForCalculation($calculation_index)
+	{
+		$schema_map = $this->schemaForCalculations();
+		return isset($schema_map[ $calculation_index ]) ? $schema_map[ $calculation_index ] : array();
+	}
 }

core/libraries/rest_api/calculations/Event.php

Spacing +6 added lines, -6 removed lines

@@ -175,7 +175,7 @@ 
      */
     public function spotsTaken($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -217,7 +217,7 @@ 
      */
     public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -260,7 +260,7 @@ 
      */
     public function registrationsCheckedInCount($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -294,7 +294,7 @@ 
      */
     public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -413,7 +413,7 @@ 
      */
     protected function calculateImageData($wpdb_row, $image_size)
     {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
+        if ( ! Event::wpdbRowHasEventId($wpdb_row)) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -429,7 +429,7 @@ 
         $EVT_ID = $wpdb_row['Event_CPT.ID'];
         $attachment_id = get_post_thumbnail_id($EVT_ID);
         $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
+        if ( ! $data) {
             return null;
         }
         $generated = true;

Indentation +560 added lines, -560 removed lines

@@ -26,564 +26,564 @@
  */
 class Event extends EventCalculationBase
 {
-    /**
-     * @var EEM_Event
-     */
-    protected $event_model;
-
-    /**
-     * @var EEM_Registration
-     */
-    protected $registration_model;
-    public function __construct(EEM_Event $event_model, EEM_Registration $registration_model)
-    {
-        $this->event_model = $event_model;
-        $this->registration_model = $registration_model;
-    }
-
-    /**
-     * Calculates the total spaces on the event (not subtracting sales, but taking
-     * sales into account; so this is the optimum sales that CAN still be achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws DomainException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     * @throws InvalidArgumentException
-     */
-    public function optimumSalesAtStart($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces();
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
-     * sales that COULD have been achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public function optimumSalesNow($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->total_available_spaces(true);
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Like optimum_sales_now, but minus total sales so far.
-     * See EE_Event::spaces_remaining_for_sale( true );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws UnexpectedEntityException
-     */
-    public function spacesRemaining($wpdb_row, $request, $controller)
-    {
-        $event_obj = null;
-        if (Event::wpdbRowHasEventId($wpdb_row)) {
-            $event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        }
-        if ($event_obj instanceof EE_Event) {
-            return $event_obj->spaces_remaining_for_sale();
-        }
-        throw new EE_Error(
-            sprintf(
-                __(
-                // @codingStandardsIgnoreStart
-                    'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                $wpdb_row['Event_CPT.ID'],
-                print_r($wpdb_row, true)
-            )
-        );
-    }
-
-
-    /**
-     * Counts the number of approved registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function spotsTaken($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        return $this->registration_model->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => EEM_Registration::status_id_approved,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
-        return $this->registration_model->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-    /**
-     * Counts all the registrations who have checked into one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int|null if permission denied
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedInCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
-        return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
-    }
-
-
-    /**
-     * Counts all the registrations who have checked out of one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return int
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestException
-     */
-    public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
-        return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
-    }
-
-
-    /**
-     * Gets the thumbnail image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'thumbnail');
-    }
-
-
-    /**
-     * Gets the medium image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageMedium($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium');
-    }
-
-
-    /**
-     * Gets the medium-large image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageMediumLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'medium_large');
-    }
-
-
-    /**
-     * Gets the large image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageLarge($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'large');
-    }
-
-
-    /**
-     * Gets the post-thumbnail image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imagePostThumbnail($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'post-thumbnail');
-    }
-
-
-    /**
-     * Gets the full size image
-     *
-     * @param array               $wpdb_row
-     * @param WP_REST_Request     $request
-     * @param EventControllerBase $controller
-     * @return array
-     * @throws EE_Error
-     */
-    public function imageFull($wpdb_row, $request, $controller)
-    {
-        return self::calculateImageData($wpdb_row, 'full');
-    }
-
-
-    /**
-     * Gets image specs and formats them for the display in the API,
-     * according to the image size requested
-     *
-     * @param array  $wpdb_row
-     * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
-     * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
-     * @throws EE_Error
-     */
-    protected function calculateImageData($wpdb_row, $image_size)
-    {
-        if (! Event::wpdbRowHasEventId($wpdb_row)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $EVT_ID = $wpdb_row['Event_CPT.ID'];
-        $attachment_id = get_post_thumbnail_id($EVT_ID);
-        $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
-            return null;
-        }
-        $generated = true;
-        if (isset($data[3])) {
-            $generated = $data[3];
-        }
-        return array(
-            'url'       => $data[0],
-            'width'     => $data[1],
-            'height'    => $data[2],
-            'generated' => $generated,
-        );
-    }
-
-
-    /**
-     * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
-     *
-     * @param array $wpdb_row
-     * @return bool
-     */
-    protected function wpdbRowHasEventId($wpdb_row)
-    {
-        return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
-    }
-
-
-    /**
-     * Provides an array for all the calculations possible that outlines a json schema for those calculations.
-     * Array is indexed by calculation (snake case) and value is the schema for that calculation.
-     *
-     * @since 4.9.68.p
-     * @return array
-     */
-    public function schemaForCalculations()
-    {
-        $image_object_properties = array(
-            'url'       => array(
-                'type' => 'string',
-            ),
-            'width'     => array(
-                'type' => 'number',
-            ),
-            'height'    => array(
-                'type' => 'number',
-            ),
-            'generated' => array(
-                'type' => 'boolean',
-            ),
-        );
-        return array(
-            'optimum_sales_at_start'          => array(
-                'description' => esc_html__(
-                    'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'optimum_sales_now'               => array(
-                'description' => esc_html__(
-                    'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'spaces_remaining'                => array(
-                'description' => esc_html__(
-                    'The optimum_sales_number result, minus total sales so far.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'spots_taken'                     => array(
-                'description' => esc_html__(
-                    'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'spots_taken_pending_payment'     => array(
-                'description' => esc_html__(
-                    'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'registrations_checked_in_count'  => array(
-                'description' => esc_html__(
-                    'The count of all the registrations who have checked into one of this event\'s datetimes.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'registrations_checked_out_count' => array(
-                'description' => esc_html__(
-                    'The count of all registrations who have checked out of one of this event\'s datetimes.',
-                    'event_espresso'
-                ),
-                'type'        => 'number',
-            ),
-            'image_thumbnail'                 => array(
-                'description'          => esc_html__(
-                    'The thumbnail image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_medium'                    => array(
-                'description'          => esc_html__(
-                    'The medium image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_medium_large'              => array(
-                'description'          => esc_html__(
-                    'The medium-large image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_large'                     => array(
-                'description'          => esc_html__(
-                    'The large image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_post_thumbnail'            => array(
-                'description'          => esc_html__(
-                    'The post-thumbnail image data.',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-            'image_full'                      => array(
-                'description'          => esc_html__(
-                    'The full size image data',
-                    'event_espresso'
-                ),
-                'type'                 => 'object',
-                'properties'           => $image_object_properties,
-                'additionalProperties' => false,
-            ),
-        );
-    }
+	/**
+	 * @var EEM_Event
+	 */
+	protected $event_model;
+
+	/**
+	 * @var EEM_Registration
+	 */
+	protected $registration_model;
+	public function __construct(EEM_Event $event_model, EEM_Registration $registration_model)
+	{
+		$this->event_model = $event_model;
+		$this->registration_model = $registration_model;
+	}
+
+	/**
+	 * Calculates the total spaces on the event (not subtracting sales, but taking
+	 * sales into account; so this is the optimum sales that CAN still be achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws DomainException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 * @throws InvalidArgumentException
+	 */
+	public function optimumSalesAtStart($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces();
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
+	 * sales that COULD have been achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public function optimumSalesNow($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->total_available_spaces(true);
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Like optimum_sales_now, but minus total sales so far.
+	 * See EE_Event::spaces_remaining_for_sale( true );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws UnexpectedEntityException
+	 */
+	public function spacesRemaining($wpdb_row, $request, $controller)
+	{
+		$event_obj = null;
+		if (Event::wpdbRowHasEventId($wpdb_row)) {
+			$event_obj = $this->event_model->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		}
+		if ($event_obj instanceof EE_Event) {
+			return $event_obj->spaces_remaining_for_sale();
+		}
+		throw new EE_Error(
+			sprintf(
+				__(
+				// @codingStandardsIgnoreStart
+					'Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				$wpdb_row['Event_CPT.ID'],
+				print_r($wpdb_row, true)
+			)
+		);
+	}
+
+
+	/**
+	 * Counts the number of approved registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function spotsTaken($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken because the database row %1$s does not have a valid entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		return $this->registration_model->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => EEM_Registration::status_id_approved,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function spotsTakenPendingPayment($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_registrations', 'spots_taken_pending_payment');
+		return $this->registration_model->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+	/**
+	 * Counts all the registrations who have checked into one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int|null if permission denied
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedInCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_in_count');
+		return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
+	}
+
+
+	/**
+	 * Counts all the registrations who have checked out of one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return int
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestException
+	 */
+	public function registrationsCheckedOutCount($wpdb_row, $request, $controller)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$this->verifyCurrentUserCan('ee_read_checkins', 'registrations_checked_out_count');
+		return $this->registration_model->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
+	}
+
+
+	/**
+	 * Gets the thumbnail image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'thumbnail');
+	}
+
+
+	/**
+	 * Gets the medium image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageMedium($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium');
+	}
+
+
+	/**
+	 * Gets the medium-large image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageMediumLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'medium_large');
+	}
+
+
+	/**
+	 * Gets the large image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageLarge($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'large');
+	}
+
+
+	/**
+	 * Gets the post-thumbnail image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imagePostThumbnail($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'post-thumbnail');
+	}
+
+
+	/**
+	 * Gets the full size image
+	 *
+	 * @param array               $wpdb_row
+	 * @param WP_REST_Request     $request
+	 * @param EventControllerBase $controller
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function imageFull($wpdb_row, $request, $controller)
+	{
+		return self::calculateImageData($wpdb_row, 'full');
+	}
+
+
+	/**
+	 * Gets image specs and formats them for the display in the API,
+	 * according to the image size requested
+	 *
+	 * @param array  $wpdb_row
+	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
+	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
+	 * @throws EE_Error
+	 */
+	protected function calculateImageData($wpdb_row, $image_size)
+	{
+		if (! Event::wpdbRowHasEventId($wpdb_row)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Cannot calculate image because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$EVT_ID = $wpdb_row['Event_CPT.ID'];
+		$attachment_id = get_post_thumbnail_id($EVT_ID);
+		$data = wp_get_attachment_image_src($attachment_id, $image_size);
+		if (! $data) {
+			return null;
+		}
+		$generated = true;
+		if (isset($data[3])) {
+			$generated = $data[3];
+		}
+		return array(
+			'url'       => $data[0],
+			'width'     => $data[1],
+			'height'    => $data[2],
+			'generated' => $generated,
+		);
+	}
+
+
+	/**
+	 * Returns true if the array of data contains 'Event_CPT.ID'. False otherwise
+	 *
+	 * @param array $wpdb_row
+	 * @return bool
+	 */
+	protected function wpdbRowHasEventId($wpdb_row)
+	{
+		return (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID']) && absint($wpdb_row['Event_CPT.ID']));
+	}
+
+
+	/**
+	 * Provides an array for all the calculations possible that outlines a json schema for those calculations.
+	 * Array is indexed by calculation (snake case) and value is the schema for that calculation.
+	 *
+	 * @since 4.9.68.p
+	 * @return array
+	 */
+	public function schemaForCalculations()
+	{
+		$image_object_properties = array(
+			'url'       => array(
+				'type' => 'string',
+			),
+			'width'     => array(
+				'type' => 'number',
+			),
+			'height'    => array(
+				'type' => 'number',
+			),
+			'generated' => array(
+				'type' => 'boolean',
+			),
+		);
+		return array(
+			'optimum_sales_at_start'          => array(
+				'description' => esc_html__(
+					'The total spaces on the event (not subtracting sales, but taking sales into account; so this is the optimum sales that CAN still be achieved.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'optimum_sales_now'               => array(
+				'description' => esc_html__(
+					'The total spaces on the event (ignoring all sales; so this is the optimum sales that could have been achieved.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'spaces_remaining'                => array(
+				'description' => esc_html__(
+					'The optimum_sales_number result, minus total sales so far.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'spots_taken'                     => array(
+				'description' => esc_html__(
+					'The number of approved registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'spots_taken_pending_payment'     => array(
+				'description' => esc_html__(
+					'The number of pending-payment registrations for this event (regardless of how many datetimes each registration\'s ticket purchase is for)',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'registrations_checked_in_count'  => array(
+				'description' => esc_html__(
+					'The count of all the registrations who have checked into one of this event\'s datetimes.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'registrations_checked_out_count' => array(
+				'description' => esc_html__(
+					'The count of all registrations who have checked out of one of this event\'s datetimes.',
+					'event_espresso'
+				),
+				'type'        => 'number',
+			),
+			'image_thumbnail'                 => array(
+				'description'          => esc_html__(
+					'The thumbnail image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_medium'                    => array(
+				'description'          => esc_html__(
+					'The medium image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_medium_large'              => array(
+				'description'          => esc_html__(
+					'The medium-large image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_large'                     => array(
+				'description'          => esc_html__(
+					'The large image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_post_thumbnail'            => array(
+				'description'          => esc_html__(
+					'The post-thumbnail image data.',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+			'image_full'                      => array(
+				'description'          => esc_html__(
+					'The full size image data',
+					'event_espresso'
+				),
+				'type'                 => 'object',
+				'properties'           => $image_object_properties,
+				'additionalProperties' => false,
+			),
+		);
+	}
 }

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

Indentation +305 added lines, -305 removed lines

@@ -31,325 +31,325 @@
 {
 
 
-    public function __construct()
-    {
-        parent::__construct();
-        EE_Registry::instance()->load_helper('Inflector');
-    }
+	public function __construct()
+	{
+		parent::__construct();
+		EE_Registry::instance()->load_helper('Inflector');
+	}
 
 
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->insert(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestInsert(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->insert(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Handles a request from \WP_REST_Server to update an EE model
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->update(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Handles a request from \WP_REST_Server to update an EE model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestUpdate(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->update(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Deletes a single model object and returns it. Unless
-     *
-     * @param WP_REST_Request $request
-     * @param string          $version
-     * @param string          $model_name
-     * @return WP_REST_Response|\WP_Error
-     */
-    public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = new Write();
-        try {
-            $controller->setRequestedVersion($version);
-            return $controller->sendResponse(
-                $controller->delete(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (\Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
+	/**
+	 * Deletes a single model object and returns it. Unless
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string          $version
+	 * @param string          $model_name
+	 * @return WP_REST_Response|\WP_Error
+	 */
+	public static function handleRequestDelete(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = new Write();
+		try {
+			$controller->setRequestedVersion($version);
+			return $controller->sendResponse(
+				$controller->delete(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (\Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
 
 
-    /**
-     * Inserts a new model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function insert(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $submitted_json_data,
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = EE_Registry::instance()->load_class(
-            $model->get_this_model_name(),
-            array($model_data, $model->get_timezone()),
-            false,
-            false
-        );
-        $model_obj->save();
-        $new_id = $model_obj->ID();
-        if (! $new_id) {
-            throw new RestException(
-                'rest_insertion_failed',
-                sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Inserts a new model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function insert(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to insert data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$submitted_json_data = array_merge((array) $request->get_body_params(), (array) $request->get_json_params());
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$submitted_json_data,
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = EE_Registry::instance()->load_class(
+			$model->get_this_model_name(),
+			array($model_data, $model->get_timezone()),
+			false,
+			false
+		);
+		$model_obj->save();
+		$new_id = $model_obj->ID();
+		if (! $new_id) {
+			throw new RestException(
+				'rest_insertion_failed',
+				sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     */
-    public function update(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        if (! $obj_id) {
-            throw new RestException(
-                'rest_edit_failed',
-                sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
-            );
-        }
-        $model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-            $this->getBodyParams($request),
-            $model,
-            $this->getModelVersionInfo()->requestedVersion(),
-            true
-        );
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $model_obj->save($model_data);
-        return $this->returnModelObjAsJsonResponse($model_obj, $request);
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function update(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to update data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		if (! $obj_id) {
+			throw new RestException(
+				'rest_edit_failed',
+				sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
+			);
+		}
+		$model_data = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+			$this->getBodyParams($request),
+			$model,
+			$this->getModelVersionInfo()->requestedVersion(),
+			true
+		);
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$model_obj->save($model_data);
+		return $this->returnModelObjAsJsonResponse($model_obj, $request);
+	}
 
 
-    /**
-     * Updates an existing model object according to the $request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array of either the soft-deleted item, or
-     * @throws EE_Error
-     */
-    public function delete(EEM_Base $model, WP_REST_Request $request)
-    {
-        Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
-        $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
-            throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
-                sprintf(
-                    esc_html__(
-                    // @codingStandardsIgnoreStart
-                        'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $default_cap_to_check_for
-                ),
-                array('status' => 403)
-            );
-        }
-        $obj_id = $request->get_param('id');
-        // this is where we would apply more fine-grained caps
-        $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                array('status' => 404)
-            );
-        }
-        $requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
-        $requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
-        if ($requested_permanent_delete) {
-            $previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
-            $deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
-            return array(
-                'deleted'  => $deleted,
-                'previous' => $previous,
-            );
-        } else {
-            if ($model instanceof EEM_Soft_Delete_Base) {
-                $model->delete_by_ID($obj_id, $requested_allow_blocking);
-                return $this->returnModelObjAsJsonResponse($model_obj, $request);
-            } else {
-                throw new RestException(
-                    'rest_trash_not_supported',
-                    501,
-                    sprintf(
-                        esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
-                        EEH_Inflector::pluralize($model->get_this_model_name())
-                    )
-                );
-            }
-        }
-    }
+	/**
+	 * Updates an existing model object according to the $request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array of either the soft-deleted item, or
+	 * @throws EE_Error
+	 */
+	public function delete(EEM_Base $model, WP_REST_Request $request)
+	{
+		Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
+		$default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
+		if (! current_user_can($default_cap_to_check_for)) {
+			throw new RestException(
+				'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+				sprintf(
+					esc_html__(
+					// @codingStandardsIgnoreStart
+						'For now, only those with the admin capability to "%1$s" are allowed to use the REST API to delete data into Event Espresso.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$default_cap_to_check_for
+				),
+				array('status' => 403)
+			);
+		}
+		$obj_id = $request->get_param('id');
+		// this is where we would apply more fine-grained caps
+		$model_obj = $model->get_one_by_ID($obj_id);
+		if (! $model_obj instanceof EE_Base_Class) {
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_invalid_id', $lowercase_model_name),
+				sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+				array('status' => 404)
+			);
+		}
+		$requested_permanent_delete = filter_var($request->get_param('force'), FILTER_VALIDATE_BOOLEAN);
+		$requested_allow_blocking = filter_var($request->get_param('allow_blocking'), FILTER_VALIDATE_BOOLEAN);
+		if ($requested_permanent_delete) {
+			$previous = $this->returnModelObjAsJsonResponse($model_obj, $request);
+			$deleted = (bool) $model->delete_permanently_by_ID($obj_id, $requested_allow_blocking);
+			return array(
+				'deleted'  => $deleted,
+				'previous' => $previous,
+			);
+		} else {
+			if ($model instanceof EEM_Soft_Delete_Base) {
+				$model->delete_by_ID($obj_id, $requested_allow_blocking);
+				return $this->returnModelObjAsJsonResponse($model_obj, $request);
+			} else {
+				throw new RestException(
+					'rest_trash_not_supported',
+					501,
+					sprintf(
+						esc_html__('%1$s do not support trashing. Set force=1 to delete.', 'event_espresso'),
+						EEH_Inflector::pluralize($model->get_this_model_name())
+					)
+				);
+			}
+		}
+	}
 
 
-    /**
-     * Returns an array ready to be converted into a JSON response, based solely on the model object
-     *
-     * @param EE_Base_Class   $model_obj
-     * @param WP_REST_Request $request
-     * @return array ready for a response
-     */
-    protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
-    {
-        $model = $model_obj->get_model();
-        // create an array exactly like the wpdb results row,
-        // so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
-        $simulated_db_row = array();
-        foreach ($model->field_settings(true) as $field_name => $field_obj) {
-            // we need to reconstruct the normal wpdb results, including the db-only fields
-            // like a secondary table's primary key. The models expect those (but don't care what value they have)
-            if ($field_obj instanceof EE_DB_Only_Field_Base) {
-                $raw_value = true;
-            } elseif ($field_obj instanceof EE_Datetime_Field) {
-                $raw_value = $model_obj->get_DateTime_object($field_name);
-            } else {
-                $raw_value = $model_obj->get_raw($field_name);
-            }
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
-        }
-        $read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        // the simulates request really doesn't need any info downstream
-        $simulated_request = new WP_REST_Request('GET');
-        return $read_controller->createEntityFromWpdbResult(
-            $model_obj->get_model(),
-            $simulated_db_row,
-            $simulated_request
-        );
-    }
+	/**
+	 * Returns an array ready to be converted into a JSON response, based solely on the model object
+	 *
+	 * @param EE_Base_Class   $model_obj
+	 * @param WP_REST_Request $request
+	 * @return array ready for a response
+	 */
+	protected function returnModelObjAsJsonResponse(EE_Base_Class $model_obj, WP_REST_Request $request)
+	{
+		$model = $model_obj->get_model();
+		// create an array exactly like the wpdb results row,
+		// so we can pass it to controllers/model/Read::create_entity_from_wpdb_result()
+		$simulated_db_row = array();
+		foreach ($model->field_settings(true) as $field_name => $field_obj) {
+			// we need to reconstruct the normal wpdb results, including the db-only fields
+			// like a secondary table's primary key. The models expect those (but don't care what value they have)
+			if ($field_obj instanceof EE_DB_Only_Field_Base) {
+				$raw_value = true;
+			} elseif ($field_obj instanceof EE_Datetime_Field) {
+				$raw_value = $model_obj->get_DateTime_object($field_name);
+			} else {
+				$raw_value = $model_obj->get_raw($field_name);
+			}
+			$simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
+		}
+		$read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		// the simulates request really doesn't need any info downstream
+		$simulated_request = new WP_REST_Request('GET');
+		return $read_controller->createEntityFromWpdbResult(
+			$model_obj->get_model(),
+			$simulated_db_row,
+			$simulated_request
+		);
+	}
 
 
-    /**
-     * Gets the item affected by this request
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param  int|string     $obj_id
-     * @return \WP_Error|array
-     */
-    protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
-    {
-        $requested_version = $this->getRequestedVersion($request->get_route());
-        $get_request = new WP_REST_Request(
-            'GET',
-            EED_Core_Rest_Api::ee_api_namespace
-            . $requested_version
-            . '/'
-            . EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-            . '/'
-            . $obj_id
-        );
-        $get_request->set_url_params(
-            array(
-                'id'      => $obj_id,
-                'include' => $request->get_param('include'),
-            )
-        );
-        $read_controller = new Read();
-        $read_controller->setRequestedVersion($this->getRequestedVersion());
-        return $read_controller->getEntityFromModel($model, $get_request);
-    }
+	/**
+	 * Gets the item affected by this request
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param  int|string     $obj_id
+	 * @return \WP_Error|array
+	 */
+	protected function getOneBasedOnRequest(EEM_Base $model, WP_REST_Request $request, $obj_id)
+	{
+		$requested_version = $this->getRequestedVersion($request->get_route());
+		$get_request = new WP_REST_Request(
+			'GET',
+			EED_Core_Rest_Api::ee_api_namespace
+			. $requested_version
+			. '/'
+			. EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+			. '/'
+			. $obj_id
+		);
+		$get_request->set_url_params(
+			array(
+				'id'      => $obj_id,
+				'include' => $request->get_param('include'),
+			)
+		);
+		$read_controller = new Read();
+		$read_controller->setRequestedVersion($this->getRequestedVersion());
+		return $read_controller->getEntityFromModel($model, $get_request);
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -126,9 +126,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'create');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_create_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_create_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -156,7 +156,7 @@ 
         );
         $model_obj->save();
         $new_id = $model_obj->ID();
-        if (! $new_id) {
+        if ( ! $new_id) {
             throw new RestException(
                 'rest_insertion_failed',
                 sprintf(__('Could not insert new %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -178,9 +178,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_edit, 'edit');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_edit_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_edit_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -194,7 +194,7 @@ 
             );
         }
         $obj_id = $request->get_param('id');
-        if (! $obj_id) {
+        if ( ! $obj_id) {
             throw new RestException(
                 'rest_edit_failed',
                 sprintf(__('Could not edit %1$s', 'event_espresso'), $model->get_this_model_name())
@@ -207,7 +207,7 @@ 
             true
         );
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -232,9 +232,9 @@ 
     {
         Capabilities::verifyAtLeastPartialAccessTo($model, EEM_Base::caps_delete, 'delete');
         $default_cap_to_check_for = EE_Restriction_Generator_Base::get_default_restrictions_cap();
-        if (! current_user_can($default_cap_to_check_for)) {
+        if ( ! current_user_can($default_cap_to_check_for)) {
             throw new RestException(
-                'rest_cannot_delete_' . EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
+                'rest_cannot_delete_'.EEH_Inflector::pluralize_and_lower(($model->get_this_model_name())),
                 sprintf(
                     esc_html__(
                     // @codingStandardsIgnoreStart
@@ -250,7 +250,7 @@ 
         $obj_id = $request->get_param('id');
         // this is where we would apply more fine-grained caps
         $model_obj = $model->get_one_by_ID($obj_id);
-        if (! $model_obj instanceof EE_Base_Class) {
+        if ( ! $model_obj instanceof EE_Base_Class) {
             $lowercase_model_name = strtolower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_invalid_id', $lowercase_model_name),
@@ -308,7 +308,7 @@ 
             } else {
                 $raw_value = $model_obj->get_raw($field_name);
             }
-            $simulated_db_row[ $field_obj->get_qualified_column() ] = $field_obj->prepare_for_use_in_db($raw_value);
+            $simulated_db_row[$field_obj->get_qualified_column()] = $field_obj->prepare_for_use_in_db($raw_value);
         }
         $read_controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         $read_controller->setRequestedVersion($this->getRequestedVersion());

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

Indentation +1346 added lines, -1346 removed lines

@@ -40,1350 +40,1350 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(CalculatedModelFields $fields_calculator)
-    {
-        parent::__construct();
-        $this->fields_calculator = $fields_calculator;
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return 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 customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($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 ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        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
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @param string $related_model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $related_model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array|WP_Error
-     */
-    public function getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            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::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] = $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array                   $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return WP_Error|array
-     * @throws RestException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = 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->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($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 getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            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 setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = 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->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base        $model
-     * @param array           $db_row     like results from $wpdb->get_results()
-     * @param WP_REST_Request $rest_request
-     * @param string          $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     */
-    public function createEntityFromWpdbResult($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->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($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->includeRequestedModels($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::filterOutInaccessibleEntityFields(
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $this->getModelVersionInfo(),
-            $model->get_index_primary_key_string(
-                $model->deduce_fields_n_values_from_cols_n_values($db_row)
-            )
-        );
-        $this->setDebugInfo(
-            '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 createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     */
-    protected function addExtraFields(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 getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation ? 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 includeRequestedModels(
-        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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    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->getEntitiesFromRelationUsingModelQueryParams(
-                    $primary_model_query_params,
-                    $relation_obj,
-                    $pretend_related_request
-                );
-                $entity_array[ Read::getRelatedEntityName($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 removeModelNamesFromArray($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
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $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 = ModelDataTranslator::prepareFieldValueForJson(
-                    null,
-                    $this->fields_calculator->retrieveCalculatedFieldValue(
-                        $model,
-                        $field_to_calculate,
-                        $wpdb_row,
-                        $rest_request,
-                        $this
-                    ),
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    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 getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName($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 getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext($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 validateDefaultQueryParams($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
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_parameters)
-    {
-        $model_query_params = array();
-        if (isset($query_parameters['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        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 = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_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 = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_parameters['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_parameters['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        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(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_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->validateContext($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->validateDefaultQueryParams(
-                $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 prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = 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;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @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 extractIncludesForThisModel($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->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @param null            $context
-     * @return array|WP_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $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'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                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_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        strtolower($model->get_this_model_name()),
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    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)
-                );
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return 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 customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($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 ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		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
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @param string $related_model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			$main_model = $controller->getModelVersionInfo()->loadModel($model_name);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$related_model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array|WP_Error
+	 */
+	public function getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			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::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] = $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array                   $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return WP_Error|array
+	 * @throws RestException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = 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->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($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::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($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 getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			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 setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = 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->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $db_row     like results from $wpdb->get_results()
+	 * @param WP_REST_Request $rest_request
+	 * @param string          $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 */
+	public function createEntityFromWpdbResult($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->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($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->includeRequestedModels($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::filterOutInaccessibleEntityFields(
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$this->getModelVersionInfo(),
+			$model->get_index_primary_key_string(
+				$model->deduce_fields_n_values_from_cols_n_values($db_row)
+			)
+		);
+		$this->setDebugInfo(
+			'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 createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ] = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 */
+	protected function addExtraFields(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 getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation ? 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 includeRequestedModels(
+		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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					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->getEntitiesFromRelationUsingModelQueryParams(
+					$primary_model_query_params,
+					$relation_obj,
+					$pretend_related_request
+				);
+				$entity_array[ Read::getRelatedEntityName($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 removeModelNamesFromArray($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
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$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 = ModelDataTranslator::prepareFieldValueForJson(
+					null,
+					$this->fields_calculator->retrieveCalculatedFieldValue(
+						$model,
+						$field_to_calculate,
+						$wpdb_row,
+						$rest_request,
+						$this
+					),
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					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 getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName($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 getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext($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 validateDefaultQueryParams($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
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_parameters)
+	{
+		$model_query_params = array();
+		if (isset($query_parameters['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		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 = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_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 = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_parameters['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_parameters['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		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(
+							__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_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->validateContext($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->validateDefaultQueryParams(
+				$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 prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = 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;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @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 extractIncludesForThisModel($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->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @param null            $context
+	 * @return array|WP_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$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'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				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_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						strtolower($model->get_this_model_name()),
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					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)
+				);
+			}
+		}
+	}
 }

Spacing +55 added lines, -55 removed lines

@@ -73,7 +73,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -114,7 +114,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -171,11 +171,11 @@ 
      */
     protected function translateDefaultsForRestResponse($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 (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -184,9 +184,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -208,9 +208,9 @@ 
     protected function maybeAddExtraFieldsToSchema($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'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -253,7 +253,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -301,7 +301,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -316,7 +316,7 @@ 
                 );
             }
             $main_model = $controller->getModelVersionInfo()->loadModel($model_name);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($related_model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -353,7 +353,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             return new WP_Error(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -365,7 +365,7 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
@@ -400,7 +400,7 @@ 
         $context = $this->validateContext($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         // check if they can access the 1st model object
@@ -417,7 +417,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('main model query params', $restricted_query_params);
         $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $model->exists($restricted_query_params)
         )
@@ -450,13 +450,13 @@ 
         }
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -507,7 +507,7 @@ 
      */
     public function getEntitiesFromRelation($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(
                     __(
@@ -549,7 +549,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -582,7 +582,7 @@ 
      */
     public function createEntityFromWpdbResult($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
@@ -663,8 +663,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -674,7 +674,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,
@@ -685,13 +685,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -700,7 +700,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -731,10 +731,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name] = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -786,7 +786,7 @@ 
     protected function addExtraFields(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() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -811,7 +811,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -827,12 +827,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -861,13 +861,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->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -913,7 +913,7 @@ 
                     $relation_obj,
                     $pretend_related_request
                 );
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results
                                                                                              instanceof
                                                                                              WP_Error
                     ? null
@@ -1045,7 +1045,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1070,7 +1070,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 (in_array(
@@ -1153,14 +1153,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'])) {
+            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(
                             __(
@@ -1206,9 +1206,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1226,9 +1226,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1260,17 +1260,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1309,9 +1309,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[] = '*';
@@ -1351,7 +1351,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 array_shift($model_rows),
@@ -1361,10 +1361,10 @@ 
             // 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_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,

core/domain/entities/shortcodes/EspressoTicketSelector.php

Indentation +82 added lines, -82 removed lines

@@ -24,92 +24,92 @@
 {
 
 
-    /**
-     * the actual shortcode tag that gets registered with WordPress
-     *
-     * @return string
-     */
-    public function getTag()
-    {
-        return 'ESPRESSO_TICKET_SELECTOR';
-    }
+	/**
+	 * the actual shortcode tag that gets registered with WordPress
+	 *
+	 * @return string
+	 */
+	public function getTag()
+	{
+		return 'ESPRESSO_TICKET_SELECTOR';
+	}
 
 
-    /**
-     * the 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()
-    {
-        return 0;
-    }
+	/**
+	 * the 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()
+	{
+		return 0;
+	}
 
 
-    /**
-     * 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
-     *
-     * @return void
-     */
-    public function initializeShortcode()
-    {
-        add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
-        $this->shortcodeHasBeenInitialized();
-    }
+	/**
+	 * 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
+	 *
+	 * @return void
+	 */
+	public function initializeShortcode()
+	{
+		add_filter('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', '__return_true');
+		$this->shortcodeHasBeenInitialized();
+	}
 
 
-    /**
-     * 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
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function processShortcode($attributes = array())
-    {
-        extract($attributes, EXTR_OVERWRITE);
-        $event_id = isset($event_id) ? $event_id : 0;
-        $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
-            if (WP_DEBUG === true && current_user_can('edit_pages')) {
-                new ExceptionStackTraceDisplay(
-                    new InvalidArgumentException(
-                        sprintf(
-                            esc_html__(
-                                'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
-                                'event_espresso'
-                            ),
-                            $this->getTag(),
-                            $event_id,
-                            'event_id',
-                            '<br />'
-                        )
-                    )
-                );
-                return '';
-            }
-            return sprintf(
-                esc_html__(
-                    'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
-                    'event_espresso'
-                ),
-                $event_id
-            );
-        }
-        ob_start();
-        do_action('AHEE_event_details_before_post', $event_id);
-        espresso_ticket_selector($event);
-        do_action('AHEE_event_details_after_post');
-        return ob_get_clean();
-    }
+	/**
+	 * 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
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function processShortcode($attributes = array())
+	{
+		extract($attributes, EXTR_OVERWRITE);
+		$event_id = isset($event_id) ? $event_id : 0;
+		$event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
+		if (! $event instanceof EE_Event) {
+			if (WP_DEBUG === true && current_user_can('edit_pages')) {
+				new ExceptionStackTraceDisplay(
+					new InvalidArgumentException(
+						sprintf(
+							esc_html__(
+								'A valid Event ID is required to use the "%1$s" shortcode.%4$sAn Event with an ID of "%2$s" could not be found.%4$sPlease verify that the shortcode added to this post\'s content includes an "%3$s" argument and that its value corresponds to a valid Event ID.',
+								'event_espresso'
+							),
+							$this->getTag(),
+							$event_id,
+							'event_id',
+							'<br />'
+						)
+					)
+				);
+				return '';
+			}
+			return sprintf(
+				esc_html__(
+					'An Event with an ID of "%s" could not be found. Please contact the event administrator for assistance.',
+					'event_espresso'
+				),
+				$event_id
+			);
+		}
+		ob_start();
+		do_action('AHEE_event_details_before_post', $event_id);
+		espresso_ticket_selector($event);
+		do_action('AHEE_event_details_after_post');
+		return ob_get_clean();
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -80,7 +80,7 @@
         extract($attributes, EXTR_OVERWRITE);
         $event_id = isset($event_id) ? $event_id : 0;
         $event = EE_Registry::instance()->load_model('Event')->get_one_by_ID($event_id);
-        if (! $event instanceof EE_Event) {
+        if ( ! $event instanceof EE_Event) {
             if (WP_DEBUG === true && current_user_can('edit_pages')) {
                 new ExceptionStackTraceDisplay(
                     new InvalidArgumentException(

core/libraries/form_sections/inputs/EE_Admin_File_Uploader_Input.input.php

Indentation +23 added lines, -23 removed lines

@@ -14,27 +14,27 @@
 class EE_Admin_File_Uploader_Input extends EE_Form_Input_Base
 {
 
-    /**
-     * @param array $input_settings
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function __construct($input_settings = array())
-    {
-        $this->_set_display_strategy(new EE_Admin_File_Uploader_Display_Strategy());
-        $this->_set_normalization_strategy(new EE_Text_Normalization());
-        $this->_add_validation_strategy(
-            LoaderFactory::getLoader()->getNew(
-                'EE_URL_Validation_Strategy',
-                array(
-                    isset($input_settings['validation_error_message'])
-                        ? $input_settings['validation_error_message']
-                        : null,
-                    true
-                )
-            )
-        );
-        parent::__construct($input_settings);
-    }
+	/**
+	 * @param array $input_settings
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function __construct($input_settings = array())
+	{
+		$this->_set_display_strategy(new EE_Admin_File_Uploader_Display_Strategy());
+		$this->_set_normalization_strategy(new EE_Text_Normalization());
+		$this->_add_validation_strategy(
+			LoaderFactory::getLoader()->getNew(
+				'EE_URL_Validation_Strategy',
+				array(
+					isset($input_settings['validation_error_message'])
+						? $input_settings['validation_error_message']
+						: null,
+					true
+				)
+			)
+		);
+		parent::__construct($input_settings);
+	}
 }