eventespresso / event-espresso-core

modules/core_rest_api/EED_Core_Rest_Api.module.php

Indentation +1366 added lines, -1366 removed lines

@@ -22,1370 +22,1370 @@
 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()
-    {
-        return parent::get_instance(EED_Core_Rest_Api::class);
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-    }
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', ['EED_Core_Rest_Api', 'set_hooks_rest_api'], 5);
-        add_action('rest_api_init', ['EED_Core_Rest_Api', 'register_routes'], 10);
-        add_filter('rest_route_data', ['EED_Core_Rest_Api', 'hide_old_endpoints'], 10, 2);
-        add_filter(
-            'rest_index',
-            ['EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex']
-        );
-    }
-
-
-    /**
-     * @since   $VID:$
-     */
-    public static function loadCalculatedModelFields()
-    {
-        EED_Core_Rest_Api::$_field_calculator = LoaderFactory::getLoader()->load(
-            'EventEspresso\core\libraries\rest_api\CalculatedModelFields'
-        );
-        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()
-    {
-        EED_Core_Rest_Api::_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([EE_LIBRARIES . 'rest_api/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
-     * @throws ReflectionException
-     */
-    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 = [];
-                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 = [
-                        'methods' => $data_for_single_endpoint['methods'],
-                        'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
-                            : [],
-                    ];
-                    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'] = static 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'];
-                    }
-                    // As of WordPress 5.5, if a permission_callback is not provided,
-                    // the REST API will issue a _doing_it_wrong notice.
-                    // Since the EE REST API defers capabilities to the db model system,
-                    // we will just use the generic WP callback for public endpoints
-                    if (! isset($single_endpoint_args['permission_callback'])) {
-                        $single_endpoint_args['permission_callback'] = '__return_true';
-                    }
-                    $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'] = static 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
-     * @throws ReflectionException
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = EED_Core_Rest_Api::_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
-     * @throws ReflectionException
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names . $version, null);
-        if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
-            $ee_routes = EED_Core_Rest_Api::_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
-     * @throws ReflectionException
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = EED_Core_Rest_Api::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 = EED_Core_Rest_Api::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
-     *
-     * @return void
-     * @deprecated since version 4.9.1
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = EED_Core_Rest_Api::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(EED_Core_Rest_Api::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 = [];
-        foreach (EED_Core_Rest_Api::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
-     * @throws ReflectionException
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_routes = [];
-        $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 ] = [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetAll',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => [
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ],
-                ],
-                'schema' => [
-                    'schema_callback' => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleSchemaRequest',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                ],
-            ];
-            $model_routes[ $singular_model_route ] = [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handleRequestGetOne',
-                    ],
-                    'callback_args'   => [$version, $model_name],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version, true),
-                ],
-            ];
-            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 ][] = [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                        'handleRequestInsert',
-                    ],
-                    'callback_args'   => [$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 ],
-                    [
-                        [
-                            'callback'        => [
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestUpdate',
-                            ],
-                            'callback_args'   => [$version, $model_name],
-                            'methods'         => WP_REST_Server::EDITABLE,
-                            'hidden_endpoint' => $hidden_endpoint,
-                            'args'            => $this->_get_write_params($model_name, $model_version_info),
-                        ],
-                        [
-                            'callback'        => [
-                                'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                                'handleRequestDelete',
-                            ],
-                            'callback_args'   => [$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
-                );
-                $model_routes[ $related_route ] = [
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handleRequestGetRelated',
-                        ],
-                        'callback_args'   => [$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),
-                    ],
-                ];
-
-                $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
-                $model_routes[ $related_write_route ] = [
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                            'handleRequestAddRelation',
-                        ],
-                        'callback_args'   => [$version, $model_name, $relation_name],
-                        'methods'         => WP_REST_Server::EDITABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_add_relation_query_params(
-                            $model,
-                            $relation_obj->get_other_model(),
-                            $version
-                        ),
-                    ],
-                    [
-                        'callback'        => [
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                            'handleRequestRemoveRelation',
-                        ],
-                        'callback_args'   => [$version, $model_name, $relation_name],
-                        'methods'         => WP_REST_Server::DELETABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => [],
-                    ],
-                ];
-            }
-        }
-        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 = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $routes[ EED_Core_Rest_Api::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 = [];
-        // checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = [
-            [
-                'callback'        => [
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handleRequestToggleCheckin',
-                ],
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => [
-                    'force' => [
-                        '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'   => [$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, $single_only = false)
-    {
-        EED_Core_Rest_Api::loadCalculatedModelFields();
-        $query_params = [
-            'include'   => [
-                'required' => false,
-                'default'  => '*',
-                'type'     => 'string',
-            ],
-            'calculate' => [
-                'required'          => false,
-                'default'           => '',
-                'enum'              => EED_Core_Rest_Api::$_field_calculator->retrieveCalculatedFieldsForModel($model),
-                'type'              => 'string',
-                // because we accept a CSV 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,
-            ],
-            'password'  => [
-                'required' => false,
-                'default'  => '',
-                'type'     => 'string',
-            ],
-        ];
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            $query_params,
-            $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 = [
-            'allow_blocking' => [
-                'required' => false,
-                'default'  => true,
-                'type'     => 'boolean',
-            ],
-        ];
-        $params_for_delete['force'] = [
-            'required' => false,
-            'default'  => false,
-            'type'     => 'boolean',
-        ];
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_delete_query_params',
-            $params_for_delete,
-            $model,
-            $version
-        );
-    }
-
-
-    /**
-     * @param EEM_Base $source_model
-     * @param EEM_Base $related_model
-     * @param          $version
-     * @return array
-     * @throws EE_Error
-     * @since $VID:$
-     */
-    protected function _get_add_relation_query_params(EEM_Base $source_model, EEM_Base $related_model, $version)
-    {
-        // if they're related through a HABTM relation, check for any non-FKs
-        $all_relation_settings = $source_model->relation_settings();
-        $relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
-        $params = [];
-        if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
-            foreach ($relation_settings->getNonKeyFields() as $field) {
-                /* @var $field EE_Model_Field_Base */
-                $params[ $field->get_name() ] = [
-                    'required'          => ! $field->is_nullable(),
-                    'default'           => ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $field->get_default_value(),
-                        $version
-                    ),
-                    'type'              => $field->getSchemaType(),
-                    'validate_callback' => null,
-                    'sanitize_callback' => null,
-                ];
-            }
-        }
-        return $params;
-    }
-
-
-    /**
-     * 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 = [];
-        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),
-            [
-                'where'    => [
-                    'required'          => false,
-                    'default'           => [],
-                    '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'    => [
-                    'required'          => false,
-                    'default'           => EED_Core_Rest_Api::get_default_query_limit(),
-                    'type'              => [
-                        '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' => [
-                    'required'          => false,
-                    'default'           => $default_orderby,
-                    'type'              => [
-                        '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' => [
-                    'required'          => false,
-                    'default'           => null,
-                    'type'              => [
-                        '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'   => [
-                    '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'     => [
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                    'type'     => 'string',
-                    'enum'     => [
-                        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
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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);
-
-        // we do our own validation and sanitization within the controller
-        $sanitize_callback = function_exists('rest_validate_value_from_schema')
-            ? ['EED_Core_Rest_Api', 'default_sanitize_callback']
-            : null;
-        $args_info = [];
-        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()
-            );
-            $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 (! EED_Core_Rest_Api::_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 = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[ EED_Core_Rest_Api::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 [
-            'config'    => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequest',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$version],
-                ],
-            ],
-            'site_info' => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handleRequestSiteInfo',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$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 = [];
-        foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[ EED_Core_Rest_Api::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 [
-            'resources' => [
-                [
-                    'callback'        => [
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handleRequestModelsMeta',
-                    ],
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'callback_args'   => [$version],
-                ],
-            ],
-        ];
-    }
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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',
-            [
-                '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 = [];
-        $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 (version_compare($key_versioned_endpoint, $lowest_compatible_version, '>=')
-                      && version_compare($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
-        );
-    }
-
-
-    /**
-     * @param string $version api version string (i.e. '4.8.36')
-     * @return array
-     */
-    public static function getCollectionRoutesIndexedByModelName($version = '')
-    {
-        $version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
-        $model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
-        $collection_routes = [];
-        foreach ($model_names as $model_name => $model_class_name) {
-            $collection_routes[ strtolower($model_name) ] = '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/'
-                                                            . EEH_Inflector::pluralize_and_lower($model_name);
-        }
-        return $collection_routes;
-    }
-
-
-    /**
-     * Returns an array of primary key names indexed by model names.
-     *
-     * @param string $version
-     * @return array
-     */
-    public static function getPrimaryKeyNamesIndexedByModelName($version = '')
-    {
-        $version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
-        $model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
-        $primary_key_items = [];
-        foreach ($model_names as $model_name => $model_class_name) {
-            $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
-            foreach ($primary_keys as $primary_key_name => $primary_key_field) {
-                if (count($primary_keys) > 1) {
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
-                } else {
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
-                }
-            }
-        }
-        return $primary_key_items;
-    }
-
-
-    /**
-     * Determines the EE REST API debug mode is activated, or not.
-     *
-     * @return bool
-     * @since 4.9.76.p
-     */
-    public static function debugMode()
-    {
-        static $debug_mode = null; // could be class prop
-        if ($debug_mode === null) {
-            $debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
-        }
-        return $debug_mode;
-    }
-
-
-    /**
-     *    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()
+	{
+		return parent::get_instance(EED_Core_Rest_Api::class);
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+	}
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', ['EED_Core_Rest_Api', 'set_hooks_rest_api'], 5);
+		add_action('rest_api_init', ['EED_Core_Rest_Api', 'register_routes'], 10);
+		add_filter('rest_route_data', ['EED_Core_Rest_Api', 'hide_old_endpoints'], 10, 2);
+		add_filter(
+			'rest_index',
+			['EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filterEeMetadataIntoIndex']
+		);
+	}
+
+
+	/**
+	 * @since   $VID:$
+	 */
+	public static function loadCalculatedModelFields()
+	{
+		EED_Core_Rest_Api::$_field_calculator = LoaderFactory::getLoader()->load(
+			'EventEspresso\core\libraries\rest_api\CalculatedModelFields'
+		);
+		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()
+	{
+		EED_Core_Rest_Api::_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([EE_LIBRARIES . 'rest_api/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
+	 * @throws ReflectionException
+	 */
+	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 = [];
+				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 = [
+						'methods' => $data_for_single_endpoint['methods'],
+						'args'    => isset($data_for_single_endpoint['args']) ? $data_for_single_endpoint['args']
+							: [],
+					];
+					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'] = static 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'];
+					}
+					// As of WordPress 5.5, if a permission_callback is not provided,
+					// the REST API will issue a _doing_it_wrong notice.
+					// Since the EE REST API defers capabilities to the db model system,
+					// we will just use the generic WP callback for public endpoints
+					if (! isset($single_endpoint_args['permission_callback'])) {
+						$single_endpoint_args['permission_callback'] = '__return_true';
+					}
+					$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'] = static 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
+	 * @throws ReflectionException
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = EED_Core_Rest_Api::_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
+	 * @throws ReflectionException
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names . $version, null);
+		if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
+			$ee_routes = EED_Core_Rest_Api::_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
+	 * @throws ReflectionException
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = EED_Core_Rest_Api::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 = EED_Core_Rest_Api::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
+	 *
+	 * @return void
+	 * @deprecated since version 4.9.1
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = EED_Core_Rest_Api::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(EED_Core_Rest_Api::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 = [];
+		foreach (EED_Core_Rest_Api::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
+	 * @throws ReflectionException
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_routes = [];
+		$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 ] = [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetAll',
+					],
+					'callback_args'   => [$version, $model_name],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => [
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					],
+				],
+				'schema' => [
+					'schema_callback' => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleSchemaRequest',
+					],
+					'callback_args'   => [$version, $model_name],
+				],
+			];
+			$model_routes[ $singular_model_route ] = [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handleRequestGetOne',
+					],
+					'callback_args'   => [$version, $model_name],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version, true),
+				],
+			];
+			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 ][] = [
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+						'handleRequestInsert',
+					],
+					'callback_args'   => [$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 ],
+					[
+						[
+							'callback'        => [
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestUpdate',
+							],
+							'callback_args'   => [$version, $model_name],
+							'methods'         => WP_REST_Server::EDITABLE,
+							'hidden_endpoint' => $hidden_endpoint,
+							'args'            => $this->_get_write_params($model_name, $model_version_info),
+						],
+						[
+							'callback'        => [
+								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+								'handleRequestDelete',
+							],
+							'callback_args'   => [$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
+				);
+				$model_routes[ $related_route ] = [
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handleRequestGetRelated',
+						],
+						'callback_args'   => [$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),
+					],
+				];
+
+				$related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
+				$model_routes[ $related_write_route ] = [
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+							'handleRequestAddRelation',
+						],
+						'callback_args'   => [$version, $model_name, $relation_name],
+						'methods'         => WP_REST_Server::EDITABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_add_relation_query_params(
+							$model,
+							$relation_obj->get_other_model(),
+							$version
+						),
+					],
+					[
+						'callback'        => [
+							'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+							'handleRequestRemoveRelation',
+						],
+						'callback_args'   => [$version, $model_name, $relation_name],
+						'methods'         => WP_REST_Server::DELETABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => [],
+					],
+				];
+			}
+		}
+		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 = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$routes[ EED_Core_Rest_Api::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 = [];
+		// checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = [
+			[
+				'callback'        => [
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handleRequestToggleCheckin',
+				],
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => [
+					'force' => [
+						'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'   => [$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, $single_only = false)
+	{
+		EED_Core_Rest_Api::loadCalculatedModelFields();
+		$query_params = [
+			'include'   => [
+				'required' => false,
+				'default'  => '*',
+				'type'     => 'string',
+			],
+			'calculate' => [
+				'required'          => false,
+				'default'           => '',
+				'enum'              => EED_Core_Rest_Api::$_field_calculator->retrieveCalculatedFieldsForModel($model),
+				'type'              => 'string',
+				// because we accept a CSV 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,
+			],
+			'password'  => [
+				'required' => false,
+				'default'  => '',
+				'type'     => 'string',
+			],
+		];
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			$query_params,
+			$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 = [
+			'allow_blocking' => [
+				'required' => false,
+				'default'  => true,
+				'type'     => 'boolean',
+			],
+		];
+		$params_for_delete['force'] = [
+			'required' => false,
+			'default'  => false,
+			'type'     => 'boolean',
+		];
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_delete_query_params',
+			$params_for_delete,
+			$model,
+			$version
+		);
+	}
+
+
+	/**
+	 * @param EEM_Base $source_model
+	 * @param EEM_Base $related_model
+	 * @param          $version
+	 * @return array
+	 * @throws EE_Error
+	 * @since $VID:$
+	 */
+	protected function _get_add_relation_query_params(EEM_Base $source_model, EEM_Base $related_model, $version)
+	{
+		// if they're related through a HABTM relation, check for any non-FKs
+		$all_relation_settings = $source_model->relation_settings();
+		$relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
+		$params = [];
+		if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
+			foreach ($relation_settings->getNonKeyFields() as $field) {
+				/* @var $field EE_Model_Field_Base */
+				$params[ $field->get_name() ] = [
+					'required'          => ! $field->is_nullable(),
+					'default'           => ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$field->get_default_value(),
+						$version
+					),
+					'type'              => $field->getSchemaType(),
+					'validate_callback' => null,
+					'sanitize_callback' => null,
+				];
+			}
+		}
+		return $params;
+	}
+
+
+	/**
+	 * 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 = [];
+		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),
+			[
+				'where'    => [
+					'required'          => false,
+					'default'           => [],
+					'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'    => [
+					'required'          => false,
+					'default'           => EED_Core_Rest_Api::get_default_query_limit(),
+					'type'              => [
+						'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' => [
+					'required'          => false,
+					'default'           => $default_orderby,
+					'type'              => [
+						'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' => [
+					'required'          => false,
+					'default'           => null,
+					'type'              => [
+						'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'   => [
+					'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'     => [
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+					'type'     => 'string',
+					'enum'     => [
+						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
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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);
+
+		// we do our own validation and sanitization within the controller
+		$sanitize_callback = function_exists('rest_validate_value_from_schema')
+			? ['EED_Core_Rest_Api', 'default_sanitize_callback']
+			: null;
+		$args_info = [];
+		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()
+			);
+			$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 (! EED_Core_Rest_Api::_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 = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[ EED_Core_Rest_Api::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 [
+			'config'    => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequest',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$version],
+				],
+			],
+			'site_info' => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handleRequestSiteInfo',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$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 = [];
+		foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[ EED_Core_Rest_Api::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 [
+			'resources' => [
+				[
+					'callback'        => [
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handleRequestModelsMeta',
+					],
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'callback_args'   => [$version],
+				],
+			],
+		];
+	}
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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',
+			[
+				'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 = [];
+		$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 (version_compare($key_versioned_endpoint, $lowest_compatible_version, '>=')
+					  && version_compare($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
+		);
+	}
+
+
+	/**
+	 * @param string $version api version string (i.e. '4.8.36')
+	 * @return array
+	 */
+	public static function getCollectionRoutesIndexedByModelName($version = '')
+	{
+		$version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
+		$model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
+		$collection_routes = [];
+		foreach ($model_names as $model_name => $model_class_name) {
+			$collection_routes[ strtolower($model_name) ] = '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/'
+															. EEH_Inflector::pluralize_and_lower($model_name);
+		}
+		return $collection_routes;
+	}
+
+
+	/**
+	 * Returns an array of primary key names indexed by model names.
+	 *
+	 * @param string $version
+	 * @return array
+	 */
+	public static function getPrimaryKeyNamesIndexedByModelName($version = '')
+	{
+		$version = empty($version) ? EED_Core_Rest_Api::latest_rest_api_version() : $version;
+		$model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
+		$primary_key_items = [];
+		foreach ($model_names as $model_name => $model_class_name) {
+			$primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
+			foreach ($primary_keys as $primary_key_name => $primary_key_field) {
+				if (count($primary_keys) > 1) {
+					$primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
+				} else {
+					$primary_key_items[ strtolower($model_name) ] = $primary_key_name;
+				}
+			}
+		}
+		return $primary_key_items;
+	}
+
+
+	/**
+	 * Determines the EE REST API debug mode is activated, or not.
+	 *
+	 * @return bool
+	 * @since 4.9.76.p
+	 */
+	public static function debugMode()
+	{
+		static $debug_mode = null; // could be class prop
+		if ($debug_mode === null) {
+			$debug_mode = defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE;
+		}
+		return $debug_mode;
+	}
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 }

Spacing +51 added lines, -51 removed lines

@@ -130,7 +130,7 @@ 
      */
     protected static function _set_hooks_for_changes()
     {
-        $folder_contents = EEH_File::get_contents_of_folders([EE_LIBRARIES . 'rest_api/changes'], false);
+        $folder_contents = EEH_File::get_contents_of_folders([EE_LIBRARIES.'rest_api/changes'], false);
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
             // ignore the base parent class
             // and legacy named classes
@@ -139,7 +139,7 @@ 
             ) {
                 continue;
             }
-            $full_classname = 'EventEspresso\core\libraries\rest_api\changes\\' . $classname_in_namespace;
+            $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) {
@@ -185,10 +185,10 @@ 
                      * }
                      */
                     // skip route options
-                    if (! is_numeric($endpoint_key)) {
+                    if ( ! is_numeric($endpoint_key)) {
                         continue;
                     }
-                    if (! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
+                    if ( ! isset($data_for_single_endpoint['callback'], $data_for_single_endpoint['methods'])) {
                         throw new EE_Error(
                             esc_html__(
                             // @codingStandardsIgnoreStart
@@ -209,7 +209,7 @@ 
                     }
                     if (isset($data_for_single_endpoint['callback_args'])) {
                         $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = static function (WP_REST_Request $request) use (
+                        $single_endpoint_args['callback'] = static function(WP_REST_Request $request) use (
                             $callback,
                             $callback_args
                         ) {
@@ -226,7 +226,7 @@ 
                     // the REST API will issue a _doing_it_wrong notice.
                     // Since the EE REST API defers capabilities to the db model system,
                     // we will just use the generic WP callback for public endpoints
-                    if (! isset($single_endpoint_args['permission_callback'])) {
+                    if ( ! isset($single_endpoint_args['permission_callback'])) {
                         $single_endpoint_args['permission_callback'] = '__return_true';
                     }
                     $multiple_endpoint_args[] = $single_endpoint_args;
@@ -235,7 +235,7 @@ 
                     $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'] = static function () use ($schema_callback, $callback_args) {
+                    $multiple_endpoint_args['schema'] = static function() use ($schema_callback, $callback_args) {
                         return call_user_func_array(
                             $schema_callback,
                             $callback_args
@@ -277,7 +277,7 @@ 
     {
         // 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);
+            delete_option(EED_Core_Rest_Api::saved_routes_option_names.$version);
         }
     }
 
@@ -297,7 +297,7 @@ 
     {
         $ee_routes = [];
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = EED_Core_Rest_Api::_get_ee_route_data_for_version(
+            $ee_routes[EED_Core_Rest_Api::ee_api_namespace.$version] = EED_Core_Rest_Api::_get_ee_route_data_for_version(
                 $version,
                 $hidden_endpoints
             );
@@ -318,8 +318,8 @@ 
      */
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
     {
-        $ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names . $version, null);
-        if (! $ee_routes || EED_Core_Rest_Api::debugMode()) {
+        $ee_routes = get_option(EED_Core_Rest_Api::saved_routes_option_names.$version, null);
+        if ( ! $ee_routes || EED_Core_Rest_Api::debugMode()) {
             $ee_routes = EED_Core_Rest_Api::_save_ee_route_data_for_version($version, $hidden_endpoints);
         }
         return $ee_routes;
@@ -347,7 +347,7 @@ 
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
             )
         );
-        $option_name = EED_Core_Rest_Api::saved_routes_option_names . $version;
+        $option_name = EED_Core_Rest_Api::saved_routes_option_names.$version;
         if (get_option($option_name)) {
             update_option($option_name, $routes, true);
         } else {
@@ -392,8 +392,8 @@ 
     {
         $model_routes = [];
         foreach (EED_Core_Rest_Api::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);
+            $model_routes[EED_Core_Rest_Api::ee_api_namespace
+                           . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
         }
         return $model_routes;
     }
@@ -462,13 +462,13 @@ 
         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) {
+            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 ] = [
+            $model_routes[$plural_model_route] = [
                 [
                     'callback'        => [
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -479,7 +479,7 @@ 
                     'hidden_endpoint' => $hidden_endpoint,
                     'args'            => $this->_get_read_query_params($model, $version),
                     '_links'          => [
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
                     ],
                 ],
                 'schema' => [
@@ -490,7 +490,7 @@ 
                     'callback_args'   => [$version, $model_name],
                 ],
             ];
-            $model_routes[ $singular_model_route ] = [
+            $model_routes[$singular_model_route] = [
                 [
                     'callback'        => [
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -507,7 +507,7 @@ 
                 EED_Core_Rest_Api::should_have_write_endpoints($model),
                 $model
             )) {
-                $model_routes[ $plural_model_route ][] = [
+                $model_routes[$plural_model_route][] = [
                     'callback'        => [
                         'EventEspresso\core\libraries\rest_api\controllers\model\Write',
                         'handleRequestInsert',
@@ -517,8 +517,8 @@ 
                     '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 ],
+                $model_routes[$singular_model_route] = array_merge(
+                    $model_routes[$singular_model_route],
                     [
                         [
                             'callback'        => [
@@ -549,7 +549,7 @@ 
                     '(?P<id>[^\/]+)',
                     $relation_obj
                 );
-                $model_routes[ $related_route ] = [
+                $model_routes[$related_route] = [
                     [
                         'callback'        => [
                             'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -562,8 +562,8 @@ 
                     ],
                 ];
 
-                $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
-                $model_routes[ $related_write_route ] = [
+                $related_write_route = $related_route.'/'.'(?P<related_id>[^\/]+)';
+                $model_routes[$related_write_route] = [
                     [
                         'callback'        => [
                             'EventEspresso\core\libraries\rest_api\controllers\model\Write',
@@ -620,7 +620,7 @@ 
      */
     public static function get_entity_route($model, $id)
     {
-        return EED_Core_Rest_Api::get_collection_route($model) . '/' . $id;
+        return EED_Core_Rest_Api::get_collection_route($model).'/'.$id;
     }
 
 
@@ -640,7 +640,7 @@ 
             $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;
+        return EED_Core_Rest_Api::get_entity_route($model, $id).'/'.$related_model_name_endpoint_part;
     }
 
 
@@ -654,7 +654,7 @@ 
      */
     public static function get_versioned_route_to($relative_route, $version = '4.8.36')
     {
-        return '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/' . $relative_route;
+        return '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'.$relative_route;
     }
 
 
@@ -668,7 +668,7 @@ 
     {
         $routes = [];
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
+            $routes[EED_Core_Rest_Api::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -801,12 +801,12 @@ 
     {
         // if they're related through a HABTM relation, check for any non-FKs
         $all_relation_settings = $source_model->relation_settings();
-        $relation_settings = $all_relation_settings[ $related_model->get_this_model_name() ];
+        $relation_settings = $all_relation_settings[$related_model->get_this_model_name()];
         $params = [];
         if ($relation_settings instanceof EE_HABTM_Relation && $relation_settings->hasNonKeyFields()) {
             foreach ($relation_settings->getNonKeyFields() as $field) {
                 /* @var $field EE_Model_Field_Base */
-                $params[ $field->get_name() ] = [
+                $params[$field->get_name()] = [
                     'required'          => ! $field->is_nullable(),
                     'default'           => ModelDataTranslator::prepareFieldValueForJson(
                         $field,
@@ -835,7 +835,7 @@ 
     {
         $default_orderby = [];
         foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[ $key_field->get_name() ] = 'ASC';
+            $default_orderby[$key_field->get_name()] = 'ASC';
         }
         return array_merge(
             $this->_get_response_selection_query_params($model, $version),
@@ -869,7 +869,7 @@ 
                     'type'              => [
                         'object',
                         'string',
-                    ],// because we accept a variety of types, WP core validation and sanitization
+                    ], // 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,
@@ -965,7 +965,7 @@ 
                 $model_version_info->requestedVersion()
             );
             $arg_info['sanitize_callback'] = $sanitize_callback;
-            $args_info[ $field_name ] = $arg_info;
+            $args_info[$field_name] = $arg_info;
             if ($field_obj instanceof EE_Datetime_Field) {
                 $gmt_arg_info = $arg_info;
                 $gmt_arg_info['description'] = sprintf(
@@ -976,7 +976,7 @@ 
                     $field_obj->get_nicename(),
                     $field_name
                 );
-                $args_info[ $field_name . '_gmt' ] = $gmt_arg_info;
+                $args_info[$field_name.'_gmt'] = $gmt_arg_info;
             }
         }
         return $args_info;
@@ -999,16 +999,16 @@ 
     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 ])) {
+        if ( ! isset($attributes['args'][$param])
+            || ! is_array($attributes['args'][$param])) {
             $validation_result = true;
         } else {
-            $args = $attributes['args'][ $param ];
+            $args = $attributes['args'][$param];
             if ((
                     $value === ''
                     || $value === null
                 )
-                && (! isset($args['required'])
+                && ( ! isset($args['required'])
                     || $args['required'] === false
                 )
             ) {
@@ -1018,7 +1018,7 @@ 
                       && $args['format'] === 'email'
             ) {
                 $validation_result = true;
-                if (! EED_Core_Rest_Api::_validate_email($value)) {
+                if ( ! EED_Core_Rest_Api::_validate_email($value)) {
                     $validation_result = new WP_Error(
                         'rest_invalid_param',
                         esc_html__(
@@ -1068,7 +1068,7 @@ 
     {
         $config_routes = [];
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_config_route_data_for_version(
+            $config_routes[EED_Core_Rest_Api::ee_api_namespace.$version] = $this->_get_config_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1123,7 +1123,7 @@ 
     {
         $meta_routes = [];
         foreach (EED_Core_Rest_Api::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[ EED_Core_Rest_Api::ee_api_namespace . $version ] = $this->_get_meta_route_data_for_version(
+            $meta_routes[EED_Core_Rest_Api::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1176,7 +1176,7 @@ 
             foreach ($relative_urls as $resource_name => $endpoints) {
                 foreach ($endpoints as $key => $endpoint) {
                     // skip schema and other route options
-                    if (! is_numeric($key)) {
+                    if ( ! is_numeric($key)) {
                         continue;
                     }
                     // by default, hide "hidden_endpoint"s, unless the request indicates
@@ -1185,9 +1185,9 @@ 
                     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 ]);
+                        $full_route = '/'.ltrim($namespace, '/');
+                        $full_route .= '/'.ltrim($resource_name, '/');
+                        unset($route_data[$full_route]);
                     }
                 }
             }
@@ -1261,19 +1261,19 @@ 
 
             if ($key_versioned_endpoint === $latest_version) {
                 // don't hide the latest version in the index
-                $versions_served[ $key_versioned_endpoint ] = false;
+                $versions_served[$key_versioned_endpoint] = false;
             } elseif (version_compare($key_versioned_endpoint, $lowest_compatible_version, '>=')
                       && version_compare($key_versioned_endpoint, EED_Core_Rest_Api::core_version(), '<')
             ) {
                 // include, but hide, previous versions which are still supported
-                $versions_served[ $key_versioned_endpoint ] = true;
+                $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;
+                $versions_served[$key_versioned_endpoint] = true;
             }
         }
         return $versions_served;
@@ -1330,7 +1330,7 @@ 
         $model_names = EED_Core_Rest_Api::model_names_with_plural_routes($version);
         $collection_routes = [];
         foreach ($model_names as $model_name => $model_class_name) {
-            $collection_routes[ strtolower($model_name) ] = '/' . EED_Core_Rest_Api::ee_api_namespace . $version . '/'
+            $collection_routes[strtolower($model_name)] = '/'.EED_Core_Rest_Api::ee_api_namespace.$version.'/'
                                                             . EEH_Inflector::pluralize_and_lower($model_name);
         }
         return $collection_routes;
@@ -1352,9 +1352,9 @@ 
             $primary_keys = $model_class_name::instance()->get_combined_primary_key_fields();
             foreach ($primary_keys as $primary_key_name => $primary_key_field) {
                 if (count($primary_keys) > 1) {
-                    $primary_key_items[ strtolower($model_name) ][] = $primary_key_name;
+                    $primary_key_items[strtolower($model_name)][] = $primary_key_name;
                 } else {
-                    $primary_key_items[ strtolower($model_name) ] = $primary_key_name;
+                    $primary_key_items[strtolower($model_name)] = $primary_key_name;
                 }
             }
         }

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

Indentation +109 added lines, -109 removed lines

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

Spacing +5 added lines, -5 removed lines

@@ -83,13 +83,13 @@ 
                     'table_alias'         => $field_obj->get_table_alias(),
                     'table_column'        => $field_obj->get_table_column(),
                 );
-                $fields_json[ $field_json['name'] ] = $field_json;
+                $fields_json[$field_json['name']] = $field_json;
             }
             $fields_json = array_merge(
                 $fields_json,
                 $this->getModelVersionInfo()->extraResourcePropertiesForModel($model)
             );
-            $response[ $model_name ]['fields'] = apply_filters(
+            $response[$model_name]['fields'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__fields',
                 $fields_json,
                 $model
@@ -101,9 +101,9 @@ 
                     'type'   => str_replace('EE_', '', get_class($relation_obj)),
                     'single' => $relation_obj instanceof EE_Belongs_To_Relation,
                 );
-                $relations_json[ $relation_name ] = $relation_json;
+                $relations_json[$relation_name] = $relation_json;
             }
-            $response[ $model_name ]['relations'] = apply_filters(
+            $response[$model_name]['relations'] = apply_filters(
                 'FHEE__Meta__handle_request_models_meta__relations',
                 $relations_json,
                 $model
@@ -128,7 +128,7 @@ 
                 'name'    => $addon->name(),
                 'version' => $addon->version(),
             );
-            $addons[ $addon_json['name'] ] = $addon_json;
+            $addons[$addon_json['name']] = $addon_json;
         }
         $response_data['ee'] = array(
             'version'              => EEM_System_Status::instance()->get_ee_version(),

core/domain/entities/routing/handlers/shared/RestApiRequests.php

Indentation +45 added lines, -45 removed lines

@@ -17,53 +17,53 @@
 class RestApiRequests extends Route
 {
 
-    /**
-     * returns true if the current request matches this route
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    public function matchesCurrentRequest(): bool
-    {
-        return $this->request->isApi() || $this->request->isWordPressApi();
-    }
+	/**
+	 * returns true if the current request matches this route
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	public function matchesCurrentRequest(): bool
+	{
+		return $this->request->isApi() || $this->request->isWordPressApi();
+	}
 
 
-    /**
-     * @since $VID:$
-     */
-    protected function registerDependencies()
-    {
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Datetime',
-            [
-                'EEM_Datetime'     => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Event',
-            [
-                'EEM_Event'        => EE_Dependency_Map::load_from_cache,
-                'EEM_Registration' => EE_Dependency_Map::load_from_cache
-            ]
-        );
-        $this->dependency_map->registerDependencies(
-            'EventEspresso\core\libraries\rest_api\calculations\Registration',
-            ['EEM_Registration' => EE_Dependency_Map::load_from_cache]
-        );
-    }
+	/**
+	 * @since $VID:$
+	 */
+	protected function registerDependencies()
+	{
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Datetime',
+			[
+				'EEM_Datetime'     => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Event',
+			[
+				'EEM_Event'        => EE_Dependency_Map::load_from_cache,
+				'EEM_Registration' => EE_Dependency_Map::load_from_cache
+			]
+		);
+		$this->dependency_map->registerDependencies(
+			'EventEspresso\core\libraries\rest_api\calculations\Registration',
+			['EEM_Registration' => EE_Dependency_Map::load_from_cache]
+		);
+	}
 
 
-    /**
-     * implements logic required to run during request
-     *
-     * @return bool
-     * @since   $VID:$
-     */
-    protected function requestHandler(): bool
-    {
-        EED_Core_Rest_Api::set_hooks_both();
-        return true;
-    }
+	/**
+	 * implements logic required to run during request
+	 *
+	 * @return bool
+	 * @since   $VID:$
+	 */
+	protected function requestHandler(): bool
+	{
+		EED_Core_Rest_Api::set_hooks_both();
+		return true;
+	}
 }

core/admin/templates/status_change_notice.template.php

Indentation +66 added lines, -66 removed lines

@@ -6,8 +6,8 @@ 
 
 $page_slug          = ! empty($page_slug) ? "{$page_slug}-page" : '';
 $unknown_error_msg  = esc_html__(
-    'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
-    'event_espresso'
+	'Oops... an unknown error has occurred on the server and this notice could not be dismissed.',
+	'event_espresso'
 );
 $failed_request_msg = esc_html__('Request failed. The server returned status code: ', 'event_espresso');
 ?>
@@ -241,100 +241,100 @@ 
             <h3><?php esc_html_e('Important Notice Regarding Status Color Codes', 'event_espresso'); ?></h3>
             <p>
                 <?php esc_html_e(
-                    'In order to correct some inconsistencies in our event, datetime, and ticket status color codes, we have made the following changes:',
-                    'event_espresso'
-                ); ?>
+					'In order to correct some inconsistencies in our event, datetime, and ticket status color codes, we have made the following changes:',
+					'event_espresso'
+				); ?>
             </p>
             <ul>
                 <li class="ee-status-event">
                     <?php printf(
-                        esc_html__(
-                            'The Event, Datetime, and Ticket "Sold Out" status colors have changed from %1$sYellow%3$s to %2$sPurple%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="yellow pill">',
-                        '<span class="purple pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Event, Datetime, and Ticket "Sold Out" status colors have changed from %1$sYellow%3$s to %2$sPurple%3$s',
+							'event_espresso'
+						),
+						'<span class="yellow pill">',
+						'<span class="purple pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-event">
                     <?php printf(
-                        esc_html__(
-                            'The Event and Datetime "Postponed" status colors have changed from %1$sPurple%3$s to %2$sYellow%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="purple pill">',
-                        '<span class="yellow pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Event and Datetime "Postponed" status colors have changed from %1$sPurple%3$s to %2$sYellow%3$s',
+							'event_espresso'
+						),
+						'<span class="purple pill">',
+						'<span class="yellow pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-event">
                     <?php printf(
-                        esc_html__(
-                            'The Event "Inactive" and Ticket "Archived" status colors have changed from %1$sPurple%3$s to %2$sCharcoal%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="purple pill">',
-                        '<span class="charcoal pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Event "Inactive" and Ticket "Archived" status colors have changed from %1$sPurple%3$s to %2$sCharcoal%3$s',
+							'event_espresso'
+						),
+						'<span class="purple pill">',
+						'<span class="charcoal pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-message">
                     <?php printf(
-                        esc_html__(
-                            'The Message "Queued For Resending" status color has changed from %1$sYellow%3$s to %2$sBlue%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="yellow pill">',
-                        '<span class="blue pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Message "Queued For Resending" status color has changed from %1$sYellow%3$s to %2$sBlue%3$s',
+							'event_espresso'
+						),
+						'<span class="yellow pill">',
+						'<span class="blue pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-message">
                     <?php printf(
-                        esc_html__(
-                            'The Message "Messenger Is Executing" status color has changed from %1$sPink%3$s to %2$sGreen%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="pink pill">',
-                        '<span class="green pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Message "Messenger Is Executing" status color has changed from %1$sPink%3$s to %2$sGreen%3$s',
+							'event_espresso'
+						),
+						'<span class="pink pill">',
+						'<span class="green pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-message">
                     <?php printf(
-                        esc_html__(
-                            'The Message "Failed" status color has changed from %1$sRed%3$s to %2$sPink%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="red pill">',
-                        '<span class="pink pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Message "Failed" status color has changed from %1$sRed%3$s to %2$sPink%3$s',
+							'event_espresso'
+						),
+						'<span class="red pill">',
+						'<span class="pink pill">',
+						'</span>'
+					); ?>
                 </li>
                 <li class="ee-status-message">
                     <?php printf(
-                        esc_html__(
-                            'The Message "Debug only" status color has changed from %1$sYellow%3$s to %2$sRed%3$s',
-                            'event_espresso'
-                        ),
-                        '<span class="yellow pill">',
-                        '<span class="red pill">',
-                        '</span>'
-                    ); ?>
+						esc_html__(
+							'The Message "Debug only" status color has changed from %1$sYellow%3$s to %2$sRed%3$s',
+							'event_espresso'
+						),
+						'<span class="yellow pill">',
+						'<span class="red pill">',
+						'</span>'
+					); ?>
                 </li>
             </ul>
             <p>
                 <?php esc_html_e(
-                    'Please accept our sincere apologies for any inconvenience this might cause.',
-                    'event_espresso'
-                ); ?>
+					'Please accept our sincere apologies for any inconvenience this might cause.',
+					'event_espresso'
+				); ?>
             </p>
             <p class="ee-dismiss-notice-pg">
                 <a href="javascript:void(0);" onclick="dismissStatusNotice();" class="ee-dismiss-notice-link">
                     <span class="pill pink"><?php
-                        esc_html_e('don\'t show this notice again please', 'event_espresso');
-                    ?></span>
+						esc_html_e('don\'t show this notice again please', 'event_espresso');
+					?></span>
                 </a>
             </p>
         </div>

core/domain/services/assets/ReactAssetManager.php

Indentation +39 added lines, -39 removed lines

@@ -20,43 +20,43 @@
 class ReactAssetManager extends AssetManager
 {
 
-    const REACT_VERSION = '17.0.1';
-
-    const JS_HANDLE_REACT = 'react';
-
-    const JS_HANDLE_REACT_DOM = 'react-dom';
-
-
-    /**
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws DomainException
-     */
-    public function addAssets()
-    {
-        // TODO get these values from router
-        $is_ee_domain = true;
-        $is_blocks_domain = false;
-
-        if (!$is_ee_domain || $is_blocks_domain) {
-            return;
-        }
-
-        wp_deregister_script(ReactAssetManager::JS_HANDLE_REACT);
-        wp_deregister_script(ReactAssetManager::JS_HANDLE_REACT_DOM);
-
-        $this->addVendorJavascript(
-            ReactAssetManager::JS_HANDLE_REACT,
-            [],
-            true,
-            ReactAssetManager::REACT_VERSION
-        );
-        $this->addVendorJavascript(
-            ReactAssetManager::JS_HANDLE_REACT_DOM,
-            [ReactAssetManager::JS_HANDLE_REACT],
-            true,
-            ReactAssetManager::REACT_VERSION
-        );
-    }
+	const REACT_VERSION = '17.0.1';
+
+	const JS_HANDLE_REACT = 'react';
+
+	const JS_HANDLE_REACT_DOM = 'react-dom';
+
+
+	/**
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws DomainException
+	 */
+	public function addAssets()
+	{
+		// TODO get these values from router
+		$is_ee_domain = true;
+		$is_blocks_domain = false;
+
+		if (!$is_ee_domain || $is_blocks_domain) {
+			return;
+		}
+
+		wp_deregister_script(ReactAssetManager::JS_HANDLE_REACT);
+		wp_deregister_script(ReactAssetManager::JS_HANDLE_REACT_DOM);
+
+		$this->addVendorJavascript(
+			ReactAssetManager::JS_HANDLE_REACT,
+			[],
+			true,
+			ReactAssetManager::REACT_VERSION
+		);
+		$this->addVendorJavascript(
+			ReactAssetManager::JS_HANDLE_REACT_DOM,
+			[ReactAssetManager::JS_HANDLE_REACT],
+			true,
+			ReactAssetManager::REACT_VERSION
+		);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
         $is_ee_domain = true;
         $is_blocks_domain = false;
 
-        if (!$is_ee_domain || $is_blocks_domain) {
+        if ( ! $is_ee_domain || $is_blocks_domain) {
             return;
         }
 

core/services/assets/AssetManager.php

Indentation +323 added lines, -323 removed lines

@@ -23,332 +23,332 @@
 abstract class AssetManager implements AssetManagerInterface
 {
 
-    /**
-     * @var AssetCollection|Asset[] $assets
-     */
-    protected $assets;
-
-    /**
-     * @var DomainInterface
-     */
-    protected $domain;
-
-    /**
-     * @var Registry $registry
-     */
-    protected $registry;
-
-
-    /**
-     * AssetRegister constructor.
-     *
-     * @param DomainInterface $domain
-     * @param AssetCollection $assets
-     * @param Registry        $registry
-     */
-    public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
-    {
-        $this->domain = $domain;
-        $this->assets = $assets;
-        $this->registry = $registry;
-        $this->registry->addAssetCollection($assets);
-        add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
-        add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
-    }
-
-
-    /**
-     * @return AssetCollection
-     */
-    public function getAssets()
-    {
-        return $this->assets;
-    }
-
-
-    /**
-     * @since 4.9.71.p
-     * @return string
-     */
-    public function assetNamespace()
-    {
-        return $this->domain->assetNamespace();
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     * @since 4.9.62.p
-     */
-    public function addJavascript(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $asset = new JavascriptAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $load_in_footer,
-            $this->domain,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a javascript asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return JavascriptAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addJs($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_JS,
-            $handle,
-            $extra_dependencies
-        );
-        $source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
-        return $this->addJavascript(
-            $handle,
-            $source,
-            $details['dependencies'],
-            true,
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param array  $dependencies
-     * @param bool   $load_in_footer
-     * @param string $version
-     * @return JavascriptAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.71.p
-     */
-    public function addVendorJavascript(
-        $handle,
-        array $dependencies = array(),
-        $load_in_footer = true,
-        $version = ''
-    ) {
-        $dev_suffix = wp_scripts_get_suffix();
-        $vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
-        return $this->addJavascript(
-            $handle,
-            "{$vendor_path}{$handle}{$dev_suffix}.js",
-            $dependencies,
-            $load_in_footer,
-            $version
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @param string $source
-     * @param array  $dependencies
-     * @param string $media
-     * @param string $version
-     * @return StylesheetAsset
-     * @throws DomainException
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @since 4.9.62.p
-     */
-    public function addStylesheet(
-        $handle,
-        $source,
-        array $dependencies = array(),
-        $media = 'all',
-        $version = ''
-    ) {
-        $asset = new StylesheetAsset(
-            $handle,
-            $source,
-            array_unique($dependencies),
-            $this->domain,
-            $media,
-            $version
-        );
-        $this->assets->add($asset, $handle);
-        return $asset;
-    }
-
-
-    /**
-     * Used to register a css asset where everything is dynamically derived from the given handle.
-     *
-     * @param string       $handle
-     * @param string|array $extra_dependencies
-     * @return StylesheetAsset
-     * @throws DuplicateCollectionIdentifierException
-     * @throws InvalidDataTypeException
-     * @throws InvalidEntityException
-     * @throws DomainException
-     */
-    public function addCss($handle, $extra_dependencies = [])
-    {
-        $details = $this->getAssetDetails(
-            Asset::TYPE_CSS,
-            $handle,
-            $extra_dependencies
-        );
-        return $this->addStylesheet(
-            $handle,
-            $this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
-            $details['dependencies'],
-            'all',
-            $details['version']
-        );
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @since 4.9.62.p
-     */
-    public function enqueueAsset($handle)
-    {
-        if ($this->assets->has($handle)) {
-            /** @var Asset $asset */
-            $asset = $this->assets->get($handle);
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * @return  void
-     * @since   $VID:$
-     */
-    public function enqueueBrowserAssets()
-    {
-        foreach ($this->assets as $asset) {
-            if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
-                $asset->enqueueAsset();
-            }
-        }
-    }
-
-
-    /**
-     * @param string $asset_type
-     * @param string $handle
-     * @param array  $extra_dependencies
-     * @return array
-     * @since 4.10.2.p
-     */
-    private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
-    {
-        $getAssetDetails = '';
-        switch ($asset_type) {
-            case Asset::TYPE_JS :
-                $getAssetDetails = 'getJsAssetDetails';
-                break;
-            case Asset::TYPE_CSS :
-                $getAssetDetails = 'getCssAssetDetails';
-                break;
-        }
-        if ($getAssetDetails === '') {
-            return ['dependencies' => [], 'version' => ''];
-        }
-        $details = $this->registry->$getAssetDetails(
-            $this->domain->assetNamespace(),
-            $handle
-        );
-        $details['dependencies'] = isset($details['dependencies'])
-            ? $details['dependencies']
-            : [];
-        $details['version'] = isset($details['version'])
-            ? $details['version']
-            : '';
-        $details['dependencies'] = ! empty($extra_dependencies)
-            ? array_merge($details['dependencies'], (array) $extra_dependencies)
-            : $details['dependencies'];
-        return $details;
-
-    }
-
-
-    /**
-     * @param string $handle
-     * @return bool
-     * @throws DomainException
-     */
-    public function verifyAssetIsRegistered($handle)
-    {
-        if (wp_script_is($handle, 'registered')) {
-            return true;
-        }
-        if (WP_DEBUG) {
-            throw new DomainException(
-                sprintf(
-                    esc_html__(
-                        'The "%1$s" script is not registered when it should be!%2$s
+	/**
+	 * @var AssetCollection|Asset[] $assets
+	 */
+	protected $assets;
+
+	/**
+	 * @var DomainInterface
+	 */
+	protected $domain;
+
+	/**
+	 * @var Registry $registry
+	 */
+	protected $registry;
+
+
+	/**
+	 * AssetRegister constructor.
+	 *
+	 * @param DomainInterface $domain
+	 * @param AssetCollection $assets
+	 * @param Registry        $registry
+	 */
+	public function __construct(DomainInterface $domain, AssetCollection $assets, Registry $registry)
+	{
+		$this->domain = $domain;
+		$this->assets = $assets;
+		$this->registry = $registry;
+		$this->registry->addAssetCollection($assets);
+		add_action('wp_enqueue_scripts', array($this, 'addAssets'), 2);
+		add_action('admin_enqueue_scripts', array($this, 'addAssets'), 2);
+	}
+
+
+	/**
+	 * @return AssetCollection
+	 */
+	public function getAssets()
+	{
+		return $this->assets;
+	}
+
+
+	/**
+	 * @since 4.9.71.p
+	 * @return string
+	 */
+	public function assetNamespace()
+	{
+		return $this->domain->assetNamespace();
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 * @since 4.9.62.p
+	 */
+	public function addJavascript(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$asset = new JavascriptAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$load_in_footer,
+			$this->domain,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a javascript asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return JavascriptAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addJs($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_JS,
+			$handle,
+			$extra_dependencies
+		);
+		$source = $this->registry->getJsUrl($this->domain->assetNamespace(), $handle);
+		return $this->addJavascript(
+			$handle,
+			$source,
+			$details['dependencies'],
+			true,
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param array  $dependencies
+	 * @param bool   $load_in_footer
+	 * @param string $version
+	 * @return JavascriptAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.71.p
+	 */
+	public function addVendorJavascript(
+		$handle,
+		array $dependencies = array(),
+		$load_in_footer = true,
+		$version = ''
+	) {
+		$dev_suffix = wp_scripts_get_suffix();
+		$vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
+		return $this->addJavascript(
+			$handle,
+			"{$vendor_path}{$handle}{$dev_suffix}.js",
+			$dependencies,
+			$load_in_footer,
+			$version
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @param string $source
+	 * @param array  $dependencies
+	 * @param string $media
+	 * @param string $version
+	 * @return StylesheetAsset
+	 * @throws DomainException
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @since 4.9.62.p
+	 */
+	public function addStylesheet(
+		$handle,
+		$source,
+		array $dependencies = array(),
+		$media = 'all',
+		$version = ''
+	) {
+		$asset = new StylesheetAsset(
+			$handle,
+			$source,
+			array_unique($dependencies),
+			$this->domain,
+			$media,
+			$version
+		);
+		$this->assets->add($asset, $handle);
+		return $asset;
+	}
+
+
+	/**
+	 * Used to register a css asset where everything is dynamically derived from the given handle.
+	 *
+	 * @param string       $handle
+	 * @param string|array $extra_dependencies
+	 * @return StylesheetAsset
+	 * @throws DuplicateCollectionIdentifierException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidEntityException
+	 * @throws DomainException
+	 */
+	public function addCss($handle, $extra_dependencies = [])
+	{
+		$details = $this->getAssetDetails(
+			Asset::TYPE_CSS,
+			$handle,
+			$extra_dependencies
+		);
+		return $this->addStylesheet(
+			$handle,
+			$this->registry->getCssUrl($this->domain->assetNamespace(), $handle),
+			$details['dependencies'],
+			'all',
+			$details['version']
+		);
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @since 4.9.62.p
+	 */
+	public function enqueueAsset($handle)
+	{
+		if ($this->assets->has($handle)) {
+			/** @var Asset $asset */
+			$asset = $this->assets->get($handle);
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * @return  void
+	 * @since   $VID:$
+	 */
+	public function enqueueBrowserAssets()
+	{
+		foreach ($this->assets as $asset) {
+			if ($asset instanceof BrowserAsset && $asset->isRegistered()) {
+				$asset->enqueueAsset();
+			}
+		}
+	}
+
+
+	/**
+	 * @param string $asset_type
+	 * @param string $handle
+	 * @param array  $extra_dependencies
+	 * @return array
+	 * @since 4.10.2.p
+	 */
+	private function getAssetDetails($asset_type, $handle, $extra_dependencies = [])
+	{
+		$getAssetDetails = '';
+		switch ($asset_type) {
+			case Asset::TYPE_JS :
+				$getAssetDetails = 'getJsAssetDetails';
+				break;
+			case Asset::TYPE_CSS :
+				$getAssetDetails = 'getCssAssetDetails';
+				break;
+		}
+		if ($getAssetDetails === '') {
+			return ['dependencies' => [], 'version' => ''];
+		}
+		$details = $this->registry->$getAssetDetails(
+			$this->domain->assetNamespace(),
+			$handle
+		);
+		$details['dependencies'] = isset($details['dependencies'])
+			? $details['dependencies']
+			: [];
+		$details['version'] = isset($details['version'])
+			? $details['version']
+			: '';
+		$details['dependencies'] = ! empty($extra_dependencies)
+			? array_merge($details['dependencies'], (array) $extra_dependencies)
+			: $details['dependencies'];
+		return $details;
+
+	}
+
+
+	/**
+	 * @param string $handle
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function verifyAssetIsRegistered($handle)
+	{
+		if (wp_script_is($handle, 'registered')) {
+			return true;
+		}
+		if (WP_DEBUG) {
+			throw new DomainException(
+				sprintf(
+					esc_html__(
+						'The "%1$s" script is not registered when it should be!%2$s
                         Are you running the Barista plugin for development purposes? 
                         If so, then you need to build the appropriate assets for this domain.%2$s
                         If you are seeing this error on a live website, then you should not have 
                         the WP_DEBUG constant in your wp-config.php file set to "true". 
                         Please contact Event Espresso support for more information.',
-                        'event_espresso'
-                    ),
-                    $handle,
-                    '<br />'
-                )
-            );
-        }
-        return false;
-    }
-
-
-    /**************** deprecated ****************/
-
-
-    /**
-     * @return void
-     * @deprecated $VID:$
-     */
-    public function addManifestFile()
-    {
-    }
-
-
-    /**
-     * @return void
-     * @deprecated $VID:$
-     */
-    public function getManifestFile()
-    {
-    }
+						'event_espresso'
+					),
+					$handle,
+					'<br />'
+				)
+			);
+		}
+		return false;
+	}
+
+
+	/**************** deprecated ****************/
+
+
+	/**
+	 * @return void
+	 * @deprecated $VID:$
+	 */
+	public function addManifestFile()
+	{
+	}
+
+
+	/**
+	 * @return void
+	 * @deprecated $VID:$
+	 */
+	public function getManifestFile()
+	{
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -157,7 +157,7 @@
         $version = ''
     ) {
         $dev_suffix = wp_scripts_get_suffix();
-        $vendor_path = $this->domain->pluginUrl() . 'assets/vendor/';
+        $vendor_path = $this->domain->pluginUrl().'assets/vendor/';
         return $this->addJavascript(
             $handle,
             "{$vendor_path}{$handle}{$dev_suffix}.js",