eventespresso / event-espresso-core

core/entities/models/JsonModelSchema.php

Doc Comments -2 removed lines

@@ -39,7 +39,6 @@ 
 
     /**
      * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getModelSchema()
@@ -103,7 +102,6 @@ 
 
     /**
      * Outputs the schema header for a model.
-     * @param \EEM_Base $model
      * @return array
      */
     public function getInitialSchemaStructure()

Spacing +3 added lines, -3 removed lines

@@ -33,7 +33,7 @@ 
      *
      * @param \EEM_Base $model
      */
-    public function __construct(EEM_Base $model){
+    public function __construct(EEM_Base $model) {
         $this->model = $model;
     }
 
@@ -60,7 +60,7 @@ 
     public function getModelSchemaForFields(array $model_fields, array $schema)
     {
         foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
+            if ( ! $model_field instanceof EE_Model_Field_Base) {
                 continue;
             }
             $schema['properties'][$field] = $model_field->getSchema();
@@ -91,7 +91,7 @@ 
     public function getModelSchemaForRelations(array $relations_on_model, array $schema)
     {
         foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
+            if ( ! $relation instanceof EE_Model_Relation_Base) {
                 continue;
             }
             $model_name_for_schema = EEH_Inflector::pluralize_and_lower($model_name);

Indentation +112 added lines, -112 removed lines

@@ -24,116 +24,116 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var \EEM_Base
-     */
-    protected $model;
-
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param \EEM_Base $model
-     */
-    public function __construct(EEM_Base $model){
-        $this->model = $model;
-    }
-
-    /**
-     * Return the schema for a given model from a given model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
-
-
-    /**
-     * Get the schema for a given set of model fields.
-     * @param \EE_Model_Field_Base[]     $model_fields
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][$field] = $model_field->getSchema();
-
-            //if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][$field]['primary_key'] = true;
-            }
-
-            //if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][$field]['foreign_key'] = array(
-                    'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
-                    'type' => 'array',
-                    'enum' => $model_field->get_model_class_names_pointed_to()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Get the schema for a given set of model relations
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][$model_name_for_schema] = $relation->getSchema();
-            $schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Outputs the schema header for a model.
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema' => 'http://json-schema.org/draft-04/schema#',
-            'title' => $this->model->get_this_model_name(),
-            'type' => 'object',
-            'properties' => array()
-        );
-    }
-
-
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     *
-     * $json_schema = new JsonModelSchema(EEM_Event::instance());
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * @var \EEM_Base
+	 */
+	protected $model;
+
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param \EEM_Base $model
+	 */
+	public function __construct(EEM_Base $model){
+		$this->model = $model;
+	}
+
+	/**
+	 * Return the schema for a given model from a given model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
+
+
+	/**
+	 * Get the schema for a given set of model fields.
+	 * @param \EE_Model_Field_Base[]     $model_fields
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][$field] = $model_field->getSchema();
+
+			//if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][$field]['primary_key'] = true;
+			}
+
+			//if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][$field]['foreign_key'] = array(
+					'description' => esc_html__('This is a foreign key the points to the given models.', 'event_espresso'),
+					'type' => 'array',
+					'enum' => $model_field->get_model_class_names_pointed_to()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Get the schema for a given set of model relations
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][$model_name_for_schema] = $relation->getSchema();
+			$schema['properties'][$model_name_for_schema]['relation_model'] = $model_name;
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Outputs the schema header for a model.
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema' => 'http://json-schema.org/draft-04/schema#',
+			'title' => $this->model->get_this_model_name(),
+			'type' => 'object',
+			'properties' => array()
+		);
+	}
+
+
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 *
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance());
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }

modules/core_rest_api/EED_Core_Rest_Api.module.php

Spacing +17 added lines, -17 removed lines

@@ -157,13 +157,13 @@ 
      */
     protected static function _set_hooks_for_changes()
     {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api'.DS.'changes'), false);
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
             //ignore the base parent class
             if ($classname_in_namespace === 'Changes_In_Base') {
                 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 EventEspresso\core\libraries\rest_api\changes\Changes_In_Base) {
@@ -195,11 +195,11 @@ 
                         $model_name = isset($route['schema_callback'][0])
                             ? $route['schema_callback'][0]
                             : '';
-                        $version = isset( $route['schema_callback'][1])
+                        $version = isset($route['schema_callback'][1])
                             ? $route['schema_callback'][1]
                             : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
+                        if ( ! empty($model_name) && ! empty($version)) {
+                            $route_args['schema'] = function() use ($model_name, $version) {
                                 return EventEspresso\core\libraries\rest_api\controllers\model\Read::handle_schema_request(
                                     $model_name,
                                     $version
@@ -245,7 +245,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);
         }
     }
 
@@ -264,7 +264,7 @@ 
     {
         $ee_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version($version,
                 $hidden_endpoints);
         }
         return $ee_routes;
@@ -282,7 +282,7 @@ 
      */
     protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
     {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
         if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
         }
@@ -310,7 +310,7 @@ 
                 $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
             )
         );
-        $option_name = self::saved_routes_option_names . $version;
+        $option_name = self::saved_routes_option_names.$version;
         if (get_option($option_name)) {
             update_option($option_name, $routes, true);
         } else {
@@ -387,13 +387,13 @@ 
             $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 = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+            $singular_model_route = $plural_model_route.'/(?P<id>\d+)';
             $model_routes[$plural_model_route] = array(
                 array(
                     'callback'        => array(
@@ -404,7 +404,7 @@ 
                     'hidden_endpoint' => $hidden_endpoint,
                     'args'            => $this->_get_read_query_params($model, $version),
                     '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace.$version.$singular_model_route),
                     ),
                     'schema_callback' => array($model_name, $version)
                 ),
@@ -440,7 +440,7 @@ 
                     $relation_name,
                     $relation_obj
                 );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+                $model_routes[$singular_model_route.'/'.$related_model_name_endpoint_part] = array(
                     array(
                         'callback'        => array(
                             'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -476,7 +476,7 @@ 
     {
         $routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $routes;
@@ -607,7 +607,7 @@ 
     {
         $config_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $config_routes;
@@ -660,7 +660,7 @@ 
     {
         $meta_routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version($version,
                 $hidden_endpoint);
         }
         return $meta_routes;
@@ -715,7 +715,7 @@ 
                     if (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
                         || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
                     ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+                        $full_route = '/'.ltrim($namespace, '/').'/'.ltrim($endpoint, '/');
                         unset($route_data[$full_route]);
                     }
                 }

Indentation +837 added lines, -837 removed lines

@@ -18,844 +18,844 @@
 class EED_Core_Rest_Api extends \EED_Module
 {
 
-    const ee_api_namespace           = 'ee/v';
+	const ee_api_namespace           = 'ee/v';
 
-    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 Calculated_Model_Fields
-     */
-    protected static $_field_calculator = null;
-
-
-
-    /**
-     * @return EED_Core_Rest_Api
-     */
-    public static function instance()
-    {
-        self::$_field_calculator = new Calculated_Model_Fields();
-        return parent::get_instance(__CLASS__);
-    }
-
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @access    public
-     * @return    void
-     */
-    public static function set_hooks_admin()
-    {
-        self::set_hooks_both();
-    }
-
-
-
-    public static function set_hooks_both()
-    {
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
-        add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
-        add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
-        add_filter('rest_index',
-            array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
-        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
-     */
-    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();
-        EED_Core_Rest_Api::maybe_notify_of_basic_auth_removal();
-    }
-
-
-
-    /**
-     * 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
-     */
-    public static function set_hooks_for_changes()
-    {
-        self::_set_hooks_for_changes();
-    }
-
-
-
-    /**
-     * If the user appears to be using WP API basic auth, tell them (via a persistent
-     * admin notice and an email) that we're going to remove it soon, so they should
-     * replace it with application passwords.
-     */
-    public static function maybe_notify_of_basic_auth_removal()
-    {
-        if (
-        apply_filters(
-            'FHEE__EED_Core_Rest_Api__maybe_notify_of_basic_auth_removal__override',
-            ! isset($_SERVER['PHP_AUTH_USER'])
-            && ! isset($_SERVER['HTTP_AUTHORIZATION'])
-        )
-        ) {
-            //sure it's a WP API request, but they aren't using basic auth, so don't bother them
-            return;
-        }
-        //ok they're using the WP API with Basic Auth
-        $message = sprintf(
-            __('We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team',
-                'event_espresso'),
-            '<a href="https://wordpress.org/plugins/application-passwords/">',
-            '</a>',
-            '<a href="https://eventespresso.com/wiki/ee4-event-apps/#authentication">',
-            '<br/>'
-        );
-        EE_Error::add_persistent_admin_notice('using_basic_auth', $message);
-        if ( ! get_option('ee_notified_admin_on_basic_auth_removal', false)) {
-            add_option('ee_notified_admin_on_basic_auth_removal', true);
-            //piggy back off EE_Error::set_content_type, which sets the content type to HTML
-            add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-            //and send the message to the site admin too
-            wp_mail(get_option('admin_email'),
-                __('Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso'), $message);
-            remove_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
-        }
-    }
-
-
-
-    /**
-     * Loads all the hooks which make requests to old versions of the API
-     * appear the same as they always did
-     */
-    protected static function _set_hooks_for_changes()
-    {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
-        foreach ($folder_contents as $classname_in_namespace => $filepath) {
-            //ignore the base parent class
-            if ($classname_in_namespace === 'Changes_In_Base') {
-                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 Changes_In_Base) {
-                    $instance_of_class->set_hooks();
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * 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
-     */
-    public static function register_routes()
-    {
-        foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
-            foreach ($relative_urls as $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    $route_args = array(
-                        array(
-                            'callback' => $route['callback'],
-                            'methods'  => $route['methods'],
-                            'args'     => isset($route['args']) ? $route['args'] : array(),
-                        )
-                    );
-                    if (isset($route['schema_callback'])) {
-                        $model_name = isset($route['schema_callback'][0])
-                            ? $route['schema_callback'][0]
-                            : '';
-                        $version = isset( $route['schema_callback'][1])
-                            ? $route['schema_callback'][1]
-                            : '';
-                        if (! empty($model_name) && ! empty($version)) {
-                            $route_args['schema'] = function () use ($model_name, $version) {
-                                return ModelRead::handle_schema_request(
-                                    $model_name,
-                                    $version
-                                );
-                            };
-                        }
-                    }
-                    register_rest_route(
-                        $namespace,
-                        $endpoint,
-                        $route_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{
-     * @type string|array $callback
-     * @type string       $methods
-     * @type boolean      $hidden_endpoint
-     * }
-     */
-    public static function get_ee_route_data()
-    {
-        $ee_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoints) {
-            $ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
-                $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Gets the EE route data from the wp options if it exists already,
-     * otherwise re-generates it and saves it to the option
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return array
-     */
-    protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $ee_routes = get_option(self::saved_routes_option_names . $version, null);
-        if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
-            $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
-        }
-        return $ee_routes;
-    }
-
-
-
-    /**
-     * Saves the EE REST API route data to a wp option and returns it
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoints
-     * @return mixed|null|void
-     */
-    protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
-    {
-        $instance = self::instance();
-        $routes = apply_filters(
-            'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
-            array_replace_recursive(
-                $instance->_get_config_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_model_route_data_for_version($version, $hidden_endpoints),
-                $instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
-            )
-        );
-        $option_name = self::saved_routes_option_names . $version;
-        if (get_option($option_name)) {
-            update_option($option_name, $routes, true);
-        } else {
-            add_option($option_name, $routes, null, 'no');
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * Calculates all the EE routes and saves it to a wordpress option so we don't
-     * need to calculate it on every request
-     *
-     * @deprecated since version 4.9.1
-     * @return void
-     */
-    public static function save_ee_routes()
-    {
-        if (EE_Maintenance_Mode::instance()->models_can_query()) {
-            $instance = self::instance();
-            $routes = apply_filters(
-                'EED_Core_Rest_Api__save_ee_routes__routes',
-                array_replace_recursive(
-                    $instance->_register_config_routes(),
-                    $instance->_register_meta_routes(),
-                    $instance->_register_model_routes(),
-                    $instance->_register_rpc_routes()
-                )
-            );
-            update_option(self::saved_routes_option_names, $routes, true);
-        }
-    }
-
-
-
-    /**
-     * Gets all the route information relating to EE models
-     *
-     * @return array @see get_ee_route_data
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_model_routes()
-    {
-        $model_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $model_routes[EED_Core_Rest_Api::ee_api_namespace
-                          . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Gets the route data for EE models in the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $model_version_info = new Model_Version_Info($version);
-        $models_to_register = apply_filters(
-            'FHEE__EED_Core_REST_API___register_model_routes',
-            $model_version_info->models_for_requested_version()
-        );
-        //let's not bother having endpoints for extra metas
-        unset($models_to_register['Extra_Meta']);
-        unset($models_to_register['Extra_Join']);
-        $model_routes = array();
-        foreach ($models_to_register 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 = EEH_Inflector::pluralize_and_lower($model_name);
-            $singular_model_route = $plural_model_route . '/(?P<id>\d+)';
-            $model_routes[$plural_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_all',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_read_query_params($model, $version),
-                    '_links'          => array(
-                        'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
-                    ),
-                    'schema_callback' => array($model_name, $version)
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_create_one' ),
-                //							'methods' => WP_REST_Server::CREATABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //						)
-            );
-            $model_routes[$singular_model_route] = array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                        'handle_request_get_one',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                    'args'            => $this->_get_response_selection_query_params($model, $version),
-                ),
-                //						array(
-                //							'callback' => array(
-                //								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                //								'handle_request_edit_one' ),
-                //							'methods' => WP_REST_Server::EDITABLE,
-                //							'hidden_endpoint' => $hidden_endpoint
-                //							),
-            );
-            //@todo: also handle  DELETE for a single item
-            foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
-                $related_model_name_endpoint_part = ModelRead::get_related_entity_name(
-                    $relation_name,
-                    $relation_obj
-                );
-                $model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
-                    array(
-                        'callback'        => array(
-                            'EventEspresso\core\libraries\rest_api\controllers\model\Read',
-                            'handle_request_get_related',
-                        ),
-                        'methods'         => WP_REST_Server::READABLE,
-                        'hidden_endpoint' => $hidden_endpoint,
-                        'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
-                    ),
-                    //							array(
-                    //								'callback' => array(
-                    //									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
-                    //									'handle_request_create_or_update_related' ),
-                    //								'methods' => WP_REST_Server::EDITABLE,
-                    //								'hidden_endpoint' => $hidden_endpoint
-                    //							)
-                );
-                //@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
-            }
-        }
-        return $model_routes;
-    }
-
-
-
-    /**
-     * Adds all the RPC-style routes (remote procedure call-like routes, ie
-     * routes that don't conform to the traditional REST CRUD-style).
-     *
-     * @deprecated since 4.9.1
-     */
-    protected function _register_rpc_routes()
-    {
-        $routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        $this_versions_routes = array();
-        //checkin endpoint
-        $this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
-            array(
-                'callback'        => array(
-                    'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
-                    'handle_request_toggle_checkin',
-                ),
-                'methods'         => WP_REST_Server::CREATABLE,
-                'hidden_endpoint' => $hidden_endpoint,
-                'args'            => array(
-                    'force' => array(
-                        'required'    => false,
-                        'default'     => false,
-                        'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
-                            'event_espresso'),
-                    ),
-                ),
-            ),
-        );
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
-            $this_versions_routes,
-            $version,
-            $hidden_endpoint
-        );
-    }
-
-
-
-    /**
-     * Gets the query params that can be used when request one or many
-     *
-     * @param EEM_Base $model
-     * @param string   $version
-     * @return array
-     */
-    protected function _get_response_selection_query_params(\EEM_Base $model, $version)
-    {
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array(
-                'include'   => array(
-                    'required' => false,
-                    'default'  => '*',
-                ),
-                'calculate' => array(
-                    'required' => false,
-                    'default'  => '',
-                    'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
-                ),
-            ),
-            $model,
-            $version
-        );
-    }
-
-
-
-    /**
-     * Gets info about reading query params that are acceptable
-     *
-     * @param \EEM_Base $model eg 'Event' or 'Venue'
-     * @param  string   $version
-     * @return array    describing the args acceptable when querying this model
-     * @throws \EE_Error
-     */
-    protected function _get_read_query_params(\EEM_Base $model, $version)
-    {
-        $default_orderby = array();
-        foreach ($model->get_combined_primary_key_fields() as $key_field) {
-            $default_orderby[$key_field->get_name()] = 'ASC';
-        }
-        return array_merge(
-            $this->_get_response_selection_query_params($model, $version),
-            array(
-                'where'    => array(
-                    'required' => false,
-                    'default'  => array(),
-                ),
-                'limit'    => array(
-                    'required' => false,
-                    'default'  => EED_Core_Rest_Api::get_default_query_limit(),
-                ),
-                'order_by' => array(
-                    'required' => false,
-                    'default'  => $default_orderby,
-                ),
-                'group_by' => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'having'   => array(
-                    'required' => false,
-                    'default'  => null,
-                ),
-                'caps'     => array(
-                    'required' => false,
-                    'default'  => EEM_Base::caps_read,
-                ),
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets routes for the config
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_config_routes()
-    {
-        $config_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $config_routes;
-    }
-
-
-
-    /**
-     * Gets routes for the config for the specified version
-     *
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_config_route_data_for_version($version, $hidden_endpoint)
-    {
-        return array(
-            'config'    => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-            'site_info' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\config\Read',
-                        'handle_request_site_info',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Gets the meta info routes
-     *
-     * @return array @see _register_model_routes
-     * @deprecated since version 4.9.1
-     */
-    protected function _register_meta_routes()
-    {
-        $meta_routes = array();
-        foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
-                $hidden_endpoint);
-        }
-        return $meta_routes;
-    }
-
-
-
-    /**
-     * @param string  $version
-     * @param boolean $hidden_endpoint
-     * @return array
-     */
-    protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
-    {
-        return array(
-            'resources' => array(
-                array(
-                    'callback'        => array(
-                        'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
-                        'handle_request_models_meta',
-                    ),
-                    'methods'         => WP_REST_Server::READABLE,
-                    'hidden_endpoint' => $hidden_endpoint,
-                ),
-            ),
-        );
-    }
-
-
-
-    /**
-     * Tries to hide old 4.6 endpoints from the
-     *
-     * @param array $route_data
-     * @return array
-     */
-    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 $endpoint => $routes) {
-                foreach ($routes as $route) {
-                    //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 (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
-                        || ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
-                    ) {
-                        $full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
-                        unset($route_data[$full_route]);
-                    }
-                }
-            }
-        }
-        return $route_data;
-    }
-
-
-
-    /**
-     * Returns an array describing which versions of core support serving requests for.
-     * Keys are core versions' major and minor version, and values are the
-     * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
-     * data by just removing a few models and fields from the responses. However, 4.15 might remove
-     * the answers table entirely, in which case it would be very difficult for
-     * it to serve 4.6-style responses.
-     * Versions of core that are missing from this array are unknowns.
-     * previous ver
-     *
-     * @return array
-     */
-    public static function version_compatibilities()
-    {
-        return apply_filters(
-            'FHEE__EED_Core_REST_API__version_compatibilities',
-            array(
-                '4.8.29' => '4.8.29',
-                '4.8.33' => '4.8.29',
-                '4.8.34' => '4.8.29',
-                '4.8.36' => '4.8.29',
-            )
-        );
-    }
-
-
-
-    /**
-     * Gets the latest API version served. Eg if there
-     * are two versions served of the API, 4.8.29 and 4.8.32, and
-     * we are on core version 4.8.34, it will return the string "4.8.32"
-     *
-     * @return string
-     */
-    public static function latest_rest_api_version()
-    {
-        $versions_served = \EED_Core_Rest_Api::versions_served();
-        $versions_served_keys = array_keys($versions_served);
-        return end($versions_served_keys);
-    }
-
-
-
-    /**
-     * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
-     * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
-     * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
-     * We also indicate whether or not this version should be put in the index or not
-     *
-     * @return array keys are API version numbers (just major and minor numbers), and values
-     * are whether or not they should be hidden
-     */
-    public static function versions_served()
-    {
-        $versions_served = array();
-        $possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
-        $lowest_compatible_version = end($possibly_served_versions);
-        reset($possibly_served_versions);
-        $versions_served_historically = array_keys($possibly_served_versions);
-        $latest_version = end($versions_served_historically);
-        reset($versions_served_historically);
-        //for each version of core we have ever served:
-        foreach ($versions_served_historically as $key_versioned_endpoint) {
-            //if it's not above the current core version, and it's compatible with the current version of core
-            if ($key_versioned_endpoint == $latest_version) {
-                //don't hide the latest version in the index
-                $versions_served[$key_versioned_endpoint] = false;
-            } else if (
-                $key_versioned_endpoint < EED_Core_Rest_Api::core_version()
-                && $key_versioned_endpoint >= $lowest_compatible_version
-            ) {
-                //include, but hide, previous versions which are still supported
-                $versions_served[$key_versioned_endpoint] = true;
-            } elseif (
-            apply_filters(
-                'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
-                false,
-                $possibly_served_versions
-            )
-            ) {
-                //if a version is no longer supported, don't include it in index or list of versions served
-                $versions_served[$key_versioned_endpoint] = true;
-            }
-        }
-        return $versions_served;
-    }
-
-
-
-    /**
-     * Gets the major and minor version of EE core's version string
-     *
-     * @return string
-     */
-    public static function core_version()
-    {
-        return apply_filters('FHEE__EED_Core_REST_API__core_version',
-            implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
-    }
-
-
-
-    /**
-     * Gets the default limit that should be used when querying for resources
-     *
-     * @return int
-     */
-    public static function get_default_query_limit()
-    {
-        //we actually don't use a const because we want folks to always use
-        //this method, not the const directly
-        return apply_filters(
-            'FHEE__EED_Core_Rest_Api__get_default_query_limit',
-            50
-        );
-    }
-
-
-
-    /**
-     *    run - initial module setup
-     *
-     * @access    public
-     * @param  WP $WP
-     * @return    void
-     */
-    public function run($WP)
-    {
-    }
+	const ee_api_namespace_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 Calculated_Model_Fields
+	 */
+	protected static $_field_calculator = null;
+
+
+
+	/**
+	 * @return EED_Core_Rest_Api
+	 */
+	public static function instance()
+	{
+		self::$_field_calculator = new Calculated_Model_Fields();
+		return parent::get_instance(__CLASS__);
+	}
+
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @access    public
+	 * @return    void
+	 */
+	public static function set_hooks_admin()
+	{
+		self::set_hooks_both();
+	}
+
+
+
+	public static function set_hooks_both()
+	{
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'register_routes'), 10);
+		add_action('rest_api_init', array('EED_Core_Rest_Api', 'set_hooks_rest_api'), 5);
+		add_filter('rest_route_data', array('EED_Core_Rest_Api', 'hide_old_endpoints'), 10, 2);
+		add_filter('rest_index',
+			array('EventEspresso\core\libraries\rest_api\controllers\model\Meta', 'filter_ee_metadata_into_index'));
+		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
+	 */
+	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();
+		EED_Core_Rest_Api::maybe_notify_of_basic_auth_removal();
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	public static function set_hooks_for_changes()
+	{
+		self::_set_hooks_for_changes();
+	}
+
+
+
+	/**
+	 * If the user appears to be using WP API basic auth, tell them (via a persistent
+	 * admin notice and an email) that we're going to remove it soon, so they should
+	 * replace it with application passwords.
+	 */
+	public static function maybe_notify_of_basic_auth_removal()
+	{
+		if (
+		apply_filters(
+			'FHEE__EED_Core_Rest_Api__maybe_notify_of_basic_auth_removal__override',
+			! isset($_SERVER['PHP_AUTH_USER'])
+			&& ! isset($_SERVER['HTTP_AUTHORIZATION'])
+		)
+		) {
+			//sure it's a WP API request, but they aren't using basic auth, so don't bother them
+			return;
+		}
+		//ok they're using the WP API with Basic Auth
+		$message = sprintf(
+			__('We noticed you\'re using the WP API, which is used by the Event Espresso 4 mobile apps. Because of security and compatibility concerns, we will soon be removing our default authentication mechanism, WP API Basic Auth, from Event Espresso. It is recommended you instead install the %1$sWP Application Passwords plugin%2$s and use it with the EE4 Mobile apps. See %3$sour mobile app documentation%2$s for more information. %4$sIf you have installed the WP API Basic Auth plugin separately, or are not using the Event Espresso 4 mobile apps, you can disregard this message.%4$sThe Event Espresso Team',
+				'event_espresso'),
+			'<a href="https://wordpress.org/plugins/application-passwords/">',
+			'</a>',
+			'<a href="https://eventespresso.com/wiki/ee4-event-apps/#authentication">',
+			'<br/>'
+		);
+		EE_Error::add_persistent_admin_notice('using_basic_auth', $message);
+		if ( ! get_option('ee_notified_admin_on_basic_auth_removal', false)) {
+			add_option('ee_notified_admin_on_basic_auth_removal', true);
+			//piggy back off EE_Error::set_content_type, which sets the content type to HTML
+			add_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+			//and send the message to the site admin too
+			wp_mail(get_option('admin_email'),
+				__('Notice of Removal of WP API Basic Auth From Event Espresso 4', 'event_espresso'), $message);
+			remove_filter('wp_mail_content_type', array('EE_Error', 'set_content_type'));
+		}
+	}
+
+
+
+	/**
+	 * Loads all the hooks which make requests to old versions of the API
+	 * appear the same as they always did
+	 */
+	protected static function _set_hooks_for_changes()
+	{
+		$folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api' . DS . 'changes'), false);
+		foreach ($folder_contents as $classname_in_namespace => $filepath) {
+			//ignore the base parent class
+			if ($classname_in_namespace === 'Changes_In_Base') {
+				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 Changes_In_Base) {
+					$instance_of_class->set_hooks();
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * 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
+	 */
+	public static function register_routes()
+	{
+		foreach (EED_Core_Rest_Api::get_ee_route_data() as $namespace => $relative_urls) {
+			foreach ($relative_urls as $endpoint => $routes) {
+				foreach ($routes as $route) {
+					$route_args = array(
+						array(
+							'callback' => $route['callback'],
+							'methods'  => $route['methods'],
+							'args'     => isset($route['args']) ? $route['args'] : array(),
+						)
+					);
+					if (isset($route['schema_callback'])) {
+						$model_name = isset($route['schema_callback'][0])
+							? $route['schema_callback'][0]
+							: '';
+						$version = isset( $route['schema_callback'][1])
+							? $route['schema_callback'][1]
+							: '';
+						if (! empty($model_name) && ! empty($version)) {
+							$route_args['schema'] = function () use ($model_name, $version) {
+								return ModelRead::handle_schema_request(
+									$model_name,
+									$version
+								);
+							};
+						}
+					}
+					register_rest_route(
+						$namespace,
+						$endpoint,
+						$route_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{
+	 * @type string|array $callback
+	 * @type string       $methods
+	 * @type boolean      $hidden_endpoint
+	 * }
+	 */
+	public static function get_ee_route_data()
+	{
+		$ee_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoints) {
+			$ee_routes[self::ee_api_namespace . $version] = self::_get_ee_route_data_for_version($version,
+				$hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Gets the EE route data from the wp options if it exists already,
+	 * otherwise re-generates it and saves it to the option
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return array
+	 */
+	protected static function _get_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$ee_routes = get_option(self::saved_routes_option_names . $version, null);
+		if ( ! $ee_routes || (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE)) {
+			$ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
+		}
+		return $ee_routes;
+	}
+
+
+
+	/**
+	 * Saves the EE REST API route data to a wp option and returns it
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoints
+	 * @return mixed|null|void
+	 */
+	protected static function _save_ee_route_data_for_version($version, $hidden_endpoints = false)
+	{
+		$instance = self::instance();
+		$routes = apply_filters(
+			'EED_Core_Rest_Api__save_ee_route_data_for_version__routes',
+			array_replace_recursive(
+				$instance->_get_config_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_meta_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_model_route_data_for_version($version, $hidden_endpoints),
+				$instance->_get_rpc_route_data_for_version($version, $hidden_endpoints)
+			)
+		);
+		$option_name = self::saved_routes_option_names . $version;
+		if (get_option($option_name)) {
+			update_option($option_name, $routes, true);
+		} else {
+			add_option($option_name, $routes, null, 'no');
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * Calculates all the EE routes and saves it to a wordpress option so we don't
+	 * need to calculate it on every request
+	 *
+	 * @deprecated since version 4.9.1
+	 * @return void
+	 */
+	public static function save_ee_routes()
+	{
+		if (EE_Maintenance_Mode::instance()->models_can_query()) {
+			$instance = self::instance();
+			$routes = apply_filters(
+				'EED_Core_Rest_Api__save_ee_routes__routes',
+				array_replace_recursive(
+					$instance->_register_config_routes(),
+					$instance->_register_meta_routes(),
+					$instance->_register_model_routes(),
+					$instance->_register_rpc_routes()
+				)
+			);
+			update_option(self::saved_routes_option_names, $routes, true);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the route information relating to EE models
+	 *
+	 * @return array @see get_ee_route_data
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_model_routes()
+	{
+		$model_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$model_routes[EED_Core_Rest_Api::ee_api_namespace
+						  . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Gets the route data for EE models in the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_model_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$model_version_info = new Model_Version_Info($version);
+		$models_to_register = apply_filters(
+			'FHEE__EED_Core_REST_API___register_model_routes',
+			$model_version_info->models_for_requested_version()
+		);
+		//let's not bother having endpoints for extra metas
+		unset($models_to_register['Extra_Meta']);
+		unset($models_to_register['Extra_Join']);
+		$model_routes = array();
+		foreach ($models_to_register 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 = EEH_Inflector::pluralize_and_lower($model_name);
+			$singular_model_route = $plural_model_route . '/(?P<id>\d+)';
+			$model_routes[$plural_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_all',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_read_query_params($model, $version),
+					'_links'          => array(
+						'self' => rest_url(EED_Core_Rest_Api::ee_api_namespace . $version . $singular_model_route),
+					),
+					'schema_callback' => array($model_name, $version)
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_create_one' ),
+				//							'methods' => WP_REST_Server::CREATABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//						)
+			);
+			$model_routes[$singular_model_route] = array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+						'handle_request_get_one',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+					'args'            => $this->_get_response_selection_query_params($model, $version),
+				),
+				//						array(
+				//							'callback' => array(
+				//								'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+				//								'handle_request_edit_one' ),
+				//							'methods' => WP_REST_Server::EDITABLE,
+				//							'hidden_endpoint' => $hidden_endpoint
+				//							),
+			);
+			//@todo: also handle  DELETE for a single item
+			foreach ($model_version_info->relation_settings($model) as $relation_name => $relation_obj) {
+				$related_model_name_endpoint_part = ModelRead::get_related_entity_name(
+					$relation_name,
+					$relation_obj
+				);
+				$model_routes[$singular_model_route . '/' . $related_model_name_endpoint_part] = array(
+					array(
+						'callback'        => array(
+							'EventEspresso\core\libraries\rest_api\controllers\model\Read',
+							'handle_request_get_related',
+						),
+						'methods'         => WP_REST_Server::READABLE,
+						'hidden_endpoint' => $hidden_endpoint,
+						'args'            => $this->_get_read_query_params($relation_obj->get_other_model(), $version),
+					),
+					//							array(
+					//								'callback' => array(
+					//									'EventEspresso\core\libraries\rest_api\controllers\model\Write',
+					//									'handle_request_create_or_update_related' ),
+					//								'methods' => WP_REST_Server::EDITABLE,
+					//								'hidden_endpoint' => $hidden_endpoint
+					//							)
+				);
+				//@todo: handle delete related and possibly remove relation (not sure hwo to distinguish)
+			}
+		}
+		return $model_routes;
+	}
+
+
+
+	/**
+	 * Adds all the RPC-style routes (remote procedure call-like routes, ie
+	 * routes that don't conform to the traditional REST CRUD-style).
+	 *
+	 * @deprecated since 4.9.1
+	 */
+	protected function _register_rpc_routes()
+	{
+		$routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$routes[self::ee_api_namespace . $version] = $this->_get_rpc_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_rpc_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		$this_versions_routes = array();
+		//checkin endpoint
+		$this_versions_routes['registrations/(?P<REG_ID>\d+)/toggle_checkin_for_datetime/(?P<DTT_ID>\d+)'] = array(
+			array(
+				'callback'        => array(
+					'EventEspresso\core\libraries\rest_api\controllers\rpc\Checkin',
+					'handle_request_toggle_checkin',
+				),
+				'methods'         => WP_REST_Server::CREATABLE,
+				'hidden_endpoint' => $hidden_endpoint,
+				'args'            => array(
+					'force' => array(
+						'required'    => false,
+						'default'     => false,
+						'description' => __('Whether to force toggle checkin, or to verify the registration status and allowed ticket uses',
+							'event_espresso'),
+					),
+				),
+			),
+		);
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___register_rpc_routes__this_versions_routes',
+			$this_versions_routes,
+			$version,
+			$hidden_endpoint
+		);
+	}
+
+
+
+	/**
+	 * Gets the query params that can be used when request one or many
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $version
+	 * @return array
+	 */
+	protected function _get_response_selection_query_params(\EEM_Base $model, $version)
+	{
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array(
+				'include'   => array(
+					'required' => false,
+					'default'  => '*',
+				),
+				'calculate' => array(
+					'required' => false,
+					'default'  => '',
+					'enum'     => self::$_field_calculator->retrieve_calculated_fields_for_model($model),
+				),
+			),
+			$model,
+			$version
+		);
+	}
+
+
+
+	/**
+	 * Gets info about reading query params that are acceptable
+	 *
+	 * @param \EEM_Base $model eg 'Event' or 'Venue'
+	 * @param  string   $version
+	 * @return array    describing the args acceptable when querying this model
+	 * @throws \EE_Error
+	 */
+	protected function _get_read_query_params(\EEM_Base $model, $version)
+	{
+		$default_orderby = array();
+		foreach ($model->get_combined_primary_key_fields() as $key_field) {
+			$default_orderby[$key_field->get_name()] = 'ASC';
+		}
+		return array_merge(
+			$this->_get_response_selection_query_params($model, $version),
+			array(
+				'where'    => array(
+					'required' => false,
+					'default'  => array(),
+				),
+				'limit'    => array(
+					'required' => false,
+					'default'  => EED_Core_Rest_Api::get_default_query_limit(),
+				),
+				'order_by' => array(
+					'required' => false,
+					'default'  => $default_orderby,
+				),
+				'group_by' => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'having'   => array(
+					'required' => false,
+					'default'  => null,
+				),
+				'caps'     => array(
+					'required' => false,
+					'default'  => EEM_Base::caps_read,
+				),
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets routes for the config
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_config_routes()
+	{
+		$config_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$config_routes[self::ee_api_namespace . $version] = $this->_get_config_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $config_routes;
+	}
+
+
+
+	/**
+	 * Gets routes for the config for the specified version
+	 *
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_config_route_data_for_version($version, $hidden_endpoint)
+	{
+		return array(
+			'config'    => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+			'site_info' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\config\Read',
+						'handle_request_site_info',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Gets the meta info routes
+	 *
+	 * @return array @see _register_model_routes
+	 * @deprecated since version 4.9.1
+	 */
+	protected function _register_meta_routes()
+	{
+		$meta_routes = array();
+		foreach (self::versions_served() as $version => $hidden_endpoint) {
+			$meta_routes[self::ee_api_namespace . $version] = $this->_get_meta_route_data_for_version($version,
+				$hidden_endpoint);
+		}
+		return $meta_routes;
+	}
+
+
+
+	/**
+	 * @param string  $version
+	 * @param boolean $hidden_endpoint
+	 * @return array
+	 */
+	protected function _get_meta_route_data_for_version($version, $hidden_endpoint = false)
+	{
+		return array(
+			'resources' => array(
+				array(
+					'callback'        => array(
+						'EventEspresso\core\libraries\rest_api\controllers\model\Meta',
+						'handle_request_models_meta',
+					),
+					'methods'         => WP_REST_Server::READABLE,
+					'hidden_endpoint' => $hidden_endpoint,
+				),
+			),
+		);
+	}
+
+
+
+	/**
+	 * Tries to hide old 4.6 endpoints from the
+	 *
+	 * @param array $route_data
+	 * @return array
+	 */
+	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 $endpoint => $routes) {
+				foreach ($routes as $route) {
+					//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 (($route['hidden_endpoint'] && $force_show_ee_namespace === '')
+						|| ($force_show_ee_namespace !== '' && $force_show_ee_namespace !== $namespace)
+					) {
+						$full_route = '/' . ltrim($namespace, '/') . '/' . ltrim($endpoint, '/');
+						unset($route_data[$full_route]);
+					}
+				}
+			}
+		}
+		return $route_data;
+	}
+
+
+
+	/**
+	 * Returns an array describing which versions of core support serving requests for.
+	 * Keys are core versions' major and minor version, and values are the
+	 * LOWEST requested version they can serve. Eg, 4.7 can serve requests for 4.6-like
+	 * data by just removing a few models and fields from the responses. However, 4.15 might remove
+	 * the answers table entirely, in which case it would be very difficult for
+	 * it to serve 4.6-style responses.
+	 * Versions of core that are missing from this array are unknowns.
+	 * previous ver
+	 *
+	 * @return array
+	 */
+	public static function version_compatibilities()
+	{
+		return apply_filters(
+			'FHEE__EED_Core_REST_API__version_compatibilities',
+			array(
+				'4.8.29' => '4.8.29',
+				'4.8.33' => '4.8.29',
+				'4.8.34' => '4.8.29',
+				'4.8.36' => '4.8.29',
+			)
+		);
+	}
+
+
+
+	/**
+	 * Gets the latest API version served. Eg if there
+	 * are two versions served of the API, 4.8.29 and 4.8.32, and
+	 * we are on core version 4.8.34, it will return the string "4.8.32"
+	 *
+	 * @return string
+	 */
+	public static function latest_rest_api_version()
+	{
+		$versions_served = \EED_Core_Rest_Api::versions_served();
+		$versions_served_keys = array_keys($versions_served);
+		return end($versions_served_keys);
+	}
+
+
+
+	/**
+	 * Using EED_Core_Rest_Api::version_compatibilities(), determines what version of
+	 * EE the API can serve requests for. Eg, if we are on 4.15 of core, and
+	 * we can serve requests from 4.12 or later, this will return array( '4.12', '4.13', '4.14', '4.15' ).
+	 * We also indicate whether or not this version should be put in the index or not
+	 *
+	 * @return array keys are API version numbers (just major and minor numbers), and values
+	 * are whether or not they should be hidden
+	 */
+	public static function versions_served()
+	{
+		$versions_served = array();
+		$possibly_served_versions = EED_Core_Rest_Api::version_compatibilities();
+		$lowest_compatible_version = end($possibly_served_versions);
+		reset($possibly_served_versions);
+		$versions_served_historically = array_keys($possibly_served_versions);
+		$latest_version = end($versions_served_historically);
+		reset($versions_served_historically);
+		//for each version of core we have ever served:
+		foreach ($versions_served_historically as $key_versioned_endpoint) {
+			//if it's not above the current core version, and it's compatible with the current version of core
+			if ($key_versioned_endpoint == $latest_version) {
+				//don't hide the latest version in the index
+				$versions_served[$key_versioned_endpoint] = false;
+			} else if (
+				$key_versioned_endpoint < EED_Core_Rest_Api::core_version()
+				&& $key_versioned_endpoint >= $lowest_compatible_version
+			) {
+				//include, but hide, previous versions which are still supported
+				$versions_served[$key_versioned_endpoint] = true;
+			} elseif (
+			apply_filters(
+				'FHEE__EED_Core_Rest_Api__versions_served__include_incompatible_versions',
+				false,
+				$possibly_served_versions
+			)
+			) {
+				//if a version is no longer supported, don't include it in index or list of versions served
+				$versions_served[$key_versioned_endpoint] = true;
+			}
+		}
+		return $versions_served;
+	}
+
+
+
+	/**
+	 * Gets the major and minor version of EE core's version string
+	 *
+	 * @return string
+	 */
+	public static function core_version()
+	{
+		return apply_filters('FHEE__EED_Core_REST_API__core_version',
+			implode('.', array_slice(explode('.', espresso_version()), 0, 3)));
+	}
+
+
+
+	/**
+	 * Gets the default limit that should be used when querying for resources
+	 *
+	 * @return int
+	 */
+	public static function get_default_query_limit()
+	{
+		//we actually don't use a const because we want folks to always use
+		//this method, not the const directly
+		return apply_filters(
+			'FHEE__EED_Core_Rest_Api__get_default_query_limit',
+			50
+		);
+	}
+
+
+
+	/**
+	 *    run - initial module setup
+	 *
+	 * @access    public
+	 * @param  WP $WP
+	 * @return    void
+	 */
+	public function run($WP)
+	{
+	}
 
 
 

core/entities/interfaces/HasSchemaInterface.php

Indentation +50 added lines, -50 removed lines

@@ -5,63 +5,63 @@
 
 interface HasSchemaInterface
 {
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     */
-    public function getSchemaDescription();
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaDescription();
 
 
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string|array
-     */
-    public function getSchemaType();
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string|array
+	 */
+	public function getSchemaType();
 
 
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties();
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties();
 
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum();
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum();
 
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return string
-     */
-    public function getSchemaFormat();
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return string
+	 */
+	public function getSchemaFormat();
 
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly();
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly();
 
 
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     */
-    public function getSchema();
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 */
+	public function getSchema();
 }
\ No newline at end of file

core/db_models/fields/EE_Text_Field_Base.php

Indentation +30 added lines, -30 removed lines

@@ -7,36 +7,36 @@
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
 
-    function prepare_for_get($value_of_field_on_model_object)
-    {
-        return is_string($value_of_field_on_model_object) ? stripslashes($value_of_field_on_model_object) : $value_of_field_on_model_object;
-    }
+	function prepare_for_get($value_of_field_on_model_object)
+	{
+		return is_string($value_of_field_on_model_object) ? stripslashes($value_of_field_on_model_object) : $value_of_field_on_model_object;
+	}
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param string $value_on_field_to_be_outputted
-     * @param string $schema
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        if ($schema == 'form_input') {
-            $value_on_field_to_be_outputted = htmlentities($value_on_field_to_be_outputted, ENT_QUOTES, 'UTF-8');
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param string $value_on_field_to_be_outputted
+	 * @param string $schema
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		if ($schema == 'form_input') {
+			$value_on_field_to_be_outputted = htmlentities($value_on_field_to_be_outputted, ENT_QUOTES, 'UTF-8');
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+	}
 
-    /**
-     * In form inputs, we should have called htmlentities and addslashes on form inputs,
-     * so we need to undo that on setting of these fields
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes(html_entity_decode(parent::prepare_for_set($value_inputted_for_field_on_model_object),
-            ENT_QUOTES, 'UTF-8'));
-    }
+	/**
+	 * In form inputs, we should have called htmlentities and addslashes on form inputs,
+	 * so we need to undo that on setting of these fields
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes(html_entity_decode(parent::prepare_for_set($value_inputted_for_field_on_model_object),
+			ENT_QUOTES, 'UTF-8'));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Primary_Key_String_Field.php

Indentation +17 added lines, -17 removed lines

@@ -4,22 +4,22 @@
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
 
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags($value_inputted_for_field_on_model_object);
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Foreign_Key_String_Field.php

Indentation +13 added lines, -13 removed lines

@@ -4,17 +4,17 @@
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return strtoupper(wp_strip_all_tags($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_All_Caps_Text_Field.php

Indentation +10 added lines, -10 removed lines

@@ -6,14 +6,14 @@
  */
 class EE_All_Caps_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * makes it all upper case, and key-like
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * makes it all upper case, and key-like
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return strtoupper(sanitize_key($value_inputted_for_field_on_model_object));
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_DB_Only_Field_Base.php

Doc Comments +1 added lines, -1 removed lines

@@ -15,7 +15,7 @@
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param string|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {

Indentation +22 added lines, -22 removed lines

@@ -11,28 +11,28 @@
 abstract class EE_DB_Only_Field_Base extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaReadOnly(true);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaReadOnly(true);
+	}
 
 
-    /**
-     * All these children classes are for the db-only (meaning, we should select them
-     * on get_all queries, update, delete, and will still want to set their default value
-     * on inserts, but the model object won't have reference to these fields)
-     *
-     * @return boolean
-     */
-    function is_db_only_field()
-    {
-        return true;
-    }
+	/**
+	 * All these children classes are for the db-only (meaning, we should select them
+	 * on get_all queries, update, delete, and will still want to set their default value
+	 * on inserts, but the model object won't have reference to these fields)
+	 *
+	 * @return boolean
+	 */
+	function is_db_only_field()
+	{
+		return true;
+	}
 }
\ No newline at end of file

core/db_models/fields/EE_Float_Field.php

Doc Comments +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
      * @param string $table_column
      * @param string $nicename
      * @param bool   $nullable
-     * @param null   $default_value
+     * @param integer|null   $default_value
      */
     public function __construct($table_column, $nicename, $nullable, $default_value = null)
     {
@@ -27,7 +27,7 @@ 
      * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
      * Returns a float
      *
-     * @param type $value_inputted_for_field_on_model_object
+     * @param string $value_inputted_for_field_on_model_object
      * @return float
      */
     function prepare_for_set($value_inputted_for_field_on_model_object)

Indentation +49 added lines, -49 removed lines

@@ -8,64 +8,64 @@
 class EE_Float_Field extends EE_Model_Field_Base
 {
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType('number');
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType('number');
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
-     * Returns a float
-     *
-     * @param type $value_inputted_for_field_on_model_object
-     * @return float
-     */
-    function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, call floatval() on it first.
+	 * Returns a float
+	 *
+	 * @param type $value_inputted_for_field_on_model_object
+	 * @return float
+	 */
+	function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
 //		echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        //remove whitespaces and thousands separators
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = str_replace(array(" ", EE_Config::instance()->currency->thsnds),
-                "", $value_inputted_for_field_on_model_object);
+		//remove whitespaces and thousands separators
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = str_replace(array(" ", EE_Config::instance()->currency->thsnds),
+				"", $value_inputted_for_field_on_model_object);
 //echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 //normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $value_inputted_for_field_on_model_object = str_replace(EE_Config::instance()->currency->dec_mrk, ".",
-                $value_inputted_for_field_on_model_object);
+			$value_inputted_for_field_on_model_object = str_replace(EE_Config::instance()->currency->dec_mrk, ".",
+				$value_inputted_for_field_on_model_object);
 //echo __LINE__."$value_inputted_for_field_on_model_object<br>";
 //double-check there's absolutely nothing left on this string besides numbers
-            $value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "",
-                $value_inputted_for_field_on_model_object);
-        }
+			$value_inputted_for_field_on_model_object = preg_replace("/[^0-9,.]/", "",
+				$value_inputted_for_field_on_model_object);
+		}
 //		echo __LINE__."$value_inputted_for_field_on_model_object<br>";
-        return floatval($value_inputted_for_field_on_model_object);
-    }
+		return floatval($value_inputted_for_field_on_model_object);
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $value_on_field_to_be_outputted
-     * @return string
-     */
-    function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
-    {
-        $EE = EE_Registry::instance();
-        return number_format($value_on_field_to_be_outputted, $EE->CFG->currency->dec_plc, $EE->CFG->currency->dec_mrk,
-            $EE->CFG->currency->thsnds);
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $value_on_field_to_be_outputted
+	 * @return string
+	 */
+	function prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema = null)
+	{
+		$EE = EE_Registry::instance();
+		return number_format($value_on_field_to_be_outputted, $EE->CFG->currency->dec_plc, $EE->CFG->currency->dec_mrk,
+			$EE->CFG->currency->thsnds);
+	}
 
-    function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
+	function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
 //		echo "prepare for set from db of ";d($value_found_in_db_for_model_object);
-        return floatval($value_found_in_db_for_model_object);
-    }
+		return floatval($value_found_in_db_for_model_object);
+	}
 }
\ No newline at end of file