eventespresso / event-espresso-core

modules/core_rest_api/EED_Core_Rest_Api.module.php

Spacing +51 added lines, -51 removed lines

@@ -123,7 +123,7 @@ 
      */
     protected static function _set_hooks_for_changes()
     {
-        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES . 'rest_api/changes'), false);
+        $folder_contents = EEH_File::get_contents_of_folders(array(EE_LIBRARIES.'rest_api/changes'), false);
         foreach ($folder_contents as $classname_in_namespace => $filepath) {
             // ignore the base parent class
             // and legacy named classes
@@ -133,7 +133,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) {
@@ -178,10 +178,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
@@ -202,7 +202,7 @@ 
                     }
                     if (isset($data_for_single_endpoint['callback_args'])) {
                         $callback_args = $data_for_single_endpoint['callback_args'];
-                        $single_endpoint_args['callback'] = function (\WP_REST_Request $request) use (
+                        $single_endpoint_args['callback'] = function(\WP_REST_Request $request) use (
                             $callback,
                             $callback_args
                         ) {
@@ -219,7 +219,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;
@@ -228,7 +228,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'] = function () use ($schema_callback, $callback_args) {
+                    $multiple_endpoint_args['schema'] = function() use ($schema_callback, $callback_args) {
                         return call_user_func_array(
                             $schema_callback,
                             $callback_args
@@ -270,7 +270,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);
         }
     }
 
@@ -289,7 +289,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(
+            $ee_routes[self::ee_api_namespace.$version] = self::_get_ee_route_data_for_version(
                 $version,
                 $hidden_endpoints
             );
@@ -309,8 +309,8 @@ 
      */
     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 || EED_Core_Rest_Api::debugMode()) {
+        $ee_routes = get_option(self::saved_routes_option_names.$version, null);
+        if ( ! $ee_routes || EED_Core_Rest_Api::debugMode()) {
             $ee_routes = self::_save_ee_route_data_for_version($version, $hidden_endpoints);
         }
         return $ee_routes;
@@ -337,7 +337,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 {
@@ -382,8 +382,8 @@ 
     {
         $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);
+            $model_routes[EED_Core_Rest_Api::ee_api_namespace
+                           . $version] = $this->_get_config_route_data_for_version($version, $hidden_endpoint);
         }
         return $model_routes;
     }
@@ -452,13 +452,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 ] = array(
+            $model_routes[$plural_model_route] = array(
                 array(
                     'callback'        => array(
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -469,7 +469,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' => array(
@@ -480,7 +480,7 @@ 
                     'callback_args'   => array($version, $model_name),
                 ),
             );
-            $model_routes[ $singular_model_route ] = array(
+            $model_routes[$singular_model_route] = array(
                 array(
                     'callback'        => array(
                         'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -499,7 +499,7 @@ 
                     $model
                 )
             ) {
-                $model_routes[ $plural_model_route ][] = array(
+                $model_routes[$plural_model_route][] = array(
                     'callback'        => array(
                         'EventEspresso\core\libraries\rest_api\controllers\model\Write',
                         'handleRequestInsert',
@@ -509,8 +509,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],
                     array(
                         array(
                             'callback'        => array(
@@ -541,7 +541,7 @@ 
                     '(?P<id>[^\/]+)',
                     $relation_obj
                 );
-                $model_routes[ $related_route ] = array(
+                $model_routes[$related_route] = array(
                     array(
                         'callback'        => array(
                             'EventEspresso\core\libraries\rest_api\controllers\model\Read',
@@ -554,8 +554,8 @@ 
                     ),
                 );
 
-                $related_write_route = $related_route . '/' . '(?P<related_id>[^\/]+)';
-                $model_routes[ $related_write_route ] = array(
+                $related_write_route = $related_route.'/'.'(?P<related_id>[^\/]+)';
+                $model_routes[$related_write_route] = array(
                     array(
                         'callback'        => array(
                             'EventEspresso\core\libraries\rest_api\controllers\model\Write',
@@ -608,7 +608,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;
     }
 
 
@@ -628,7 +628,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;
     }
 
 
@@ -642,7 +642,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;
     }
 
 
@@ -656,7 +656,7 @@ 
     {
         $routes = array();
         foreach (self::versions_served() as $version => $hidden_endpoint) {
-            $routes[ self::ee_api_namespace . $version ] = $this->_get_rpc_route_data_for_version(
+            $routes[self::ee_api_namespace.$version] = $this->_get_rpc_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -779,12 +779,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 = array();
         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() ] = array(
+                $params[$field->get_name()] = array(
                     'required' => ! $field->is_nullable(),
                     'default' => ModelDataTranslator::prepareFieldValueForJson($field, $field->get_default_value(), $version),
                     'type' => $field->getSchemaType(),
@@ -809,7 +809,7 @@ 
     {
         $default_orderby = array();
         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),
@@ -843,7 +843,7 @@ 
                     'type'              => array(
                         '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,
@@ -942,7 +942,7 @@ 
                 $sanitize_callback = null;
             }
             $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(
@@ -953,7 +953,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;
@@ -977,18 +977,18 @@ 
     {
         $attributes = $request->get_attributes();
         if (
-            ! isset($attributes['args'][ $param ])
-            || ! is_array($attributes['args'][ $param ])
+            ! 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
                 )
             ) {
@@ -999,7 +999,7 @@ 
                       && $args['format'] === 'email'
             ) {
                 $validation_result = true;
-                if (! self::_validate_email($value)) {
+                if ( ! self::_validate_email($value)) {
                     $validation_result = new WP_Error(
                         'rest_invalid_param',
                         esc_html__(
@@ -1049,7 +1049,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(
+            $config_routes[self::ee_api_namespace.$version] = $this->_get_config_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1104,7 +1104,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(
+            $meta_routes[self::ee_api_namespace.$version] = $this->_get_meta_route_data_for_version(
                 $version,
                 $hidden_endpoint
             );
@@ -1156,7 +1156,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
@@ -1166,9 +1166,9 @@ 
                         ($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]);
                     }
                 }
             }
@@ -1242,13 +1242,13 @@ 
 
             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',
@@ -1257,7 +1257,7 @@ 
                 )
             ) {
                 // 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;
@@ -1315,7 +1315,7 @@ 
         $model_names = self::model_names_with_plural_routes($version);
         $collection_routes = array();
         foreach ($model_names as $model_name => $model_class_name) {
-            $collection_routes[ strtolower($model_name) ] = '/' . self::ee_api_namespace . $version . '/'
+            $collection_routes[strtolower($model_name)] = '/'.self::ee_api_namespace.$version.'/'
                                                             . EEH_Inflector::pluralize_and_lower($model_name);
         }
         return $collection_routes;
@@ -1336,9 +1336,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;
                 }
             }
         }

Indentation +1348 added lines, -1348 removed lines

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

modules/ticket_selector/EED_Ticket_Selector.module.php

Spacing +8 added lines, -8 removed lines

@@ -138,10 +138,10 @@ 
         if (defined('TICKET_SELECTOR_ASSETS_URL')) {
             return;
         }
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__).'assets/');
         define(
             'TICKET_SELECTOR_TEMPLATES_PATH',
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
+            str_replace('\\', '/', plugin_dir_path(__FILE__)).'templates/'
         );
         // initialize config
         EED_Ticket_Selector::instance()->set_config();
@@ -163,7 +163,7 @@ 
      */
     public static function ticketSelector()
     {
-        if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+        if ( ! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
             EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(
                 EED_Ticket_Selector::getRequest(),
                 EED_Ticket_Selector::ticketConfig(),
@@ -190,7 +190,7 @@ 
      */
     public static function getIframeEmbedButton()
     {
-        if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
+        if ( ! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
             self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
         }
         return self::$iframe_embed_button;
@@ -298,7 +298,7 @@ 
             // add some style
             wp_register_style(
                 'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css',
                 [],
                 EVENT_ESPRESSO_VERSION
             );
@@ -306,7 +306,7 @@ 
             // make it dance
             wp_register_script(
                 'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
+                TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js',
                 ['espresso_core'],
                 EVENT_ESPRESSO_VERSION,
                 true
@@ -353,7 +353,7 @@ 
      */
     public static function iframeCss(array $iframe_css)
     {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.css';
         return $iframe_css;
     }
 
@@ -366,7 +366,7 @@ 
      */
     public static function iframeJs(array $iframe_js)
     {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL.'ticket_selector.js';
         return $iframe_js;
     }
 

Indentation +487 added lines, -487 removed lines

@@ -18,491 +18,491 @@
  */
 class EED_Ticket_Selector extends EED_Module
 {
-    /**
-     * @var DisplayTicketSelector $ticket_selector
-     */
-    private static $ticket_selector;
-
-    /**
-     * @var TicketSelectorIframeEmbedButton $iframe_embed_button
-     */
-    private static $iframe_embed_button;
-
-
-    /**
-     * @return EED_Module|EED_Ticket_Selector
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function instance()
-    {
-        return parent::get_instance(__CLASS__);
-    }
-
-
-    /**
-     * @return EE_Ticket_Selector_Config
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function ticketConfig()
-    {
-        EED_Ticket_Selector::instance()->set_config();
-        return EED_Ticket_Selector::instance()->config();
-    }
-
-
-    /**
-     * @return void
-     */
-    protected function set_config()
-    {
-        if ($this->_config instanceof EE_Ticket_Selector_Config) {
-            return;
-        }
-        $this->set_config_section('template_settings');
-        $this->set_config_class('EE_Ticket_Selector_Config');
-        $this->set_config_name('EED_Ticket_Selector');
-    }
-
-
-    /**
-     *    set_hooks - for hooking into EE Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks()
-    {
-        // routing
-        EE_Config::register_route(
-            'iframe',
-            'EED_Ticket_Selector',
-            'ticket_selector_iframe',
-            'ticket_selector'
-        );
-        EE_Config::register_route(
-            'process_ticket_selections',
-            'EED_Ticket_Selector',
-            'process_ticket_selections'
-        );
-        EE_Config::register_route(
-            'cancel_ticket_selections',
-            'EED_Ticket_Selector',
-            'cancel_ticket_selections'
-        );
-        add_action('wp_loaded', ['EED_Ticket_Selector', 'set_definitions'], 2);
-        add_action('AHEE_event_details_header_bottom', ['EED_Ticket_Selector', 'display_ticket_selector'], 10, 1);
-        add_action('wp_enqueue_scripts', ['EED_Ticket_Selector', 'translate_js_strings'], 0);
-        add_action('wp_enqueue_scripts', ['EED_Ticket_Selector', 'load_tckt_slctr_assets'], 10);
-        EED_Ticket_Selector::loadIframeAssets();
-    }
-
-
-    /**
-     *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
-     *
-     * @return void
-     */
-    public static function set_hooks_admin()
-    {
-        // hook into the end of the \EE_Admin_Page::_load_page_dependencies()
-        // to load assets for "espresso_events" page on the "edit" route (action)
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
-            ['EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'],
-            10
-        );
-        /**
-         * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
-         * registrations work.
-         */
-        add_action(
-            'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
-            ['EED_Ticket_Selector', 'set_definitions'],
-            10
-        );
-    }
-
-
-    /**
-     *    set_definitions
-     *
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function set_definitions()
-    {
-        // don't do this twice
-        if (defined('TICKET_SELECTOR_ASSETS_URL')) {
-            return;
-        }
-        define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
-        define(
-            'TICKET_SELECTOR_TEMPLATES_PATH',
-            str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
-        );
-        // initialize config
-        EED_Ticket_Selector::instance()->set_config();
-        // if config is not set, initialize
-        if (
-            ! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
-        ) {
-            EED_Ticket_Selector::instance()->set_config();
-            EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector =
-                EED_Ticket_Selector::instance()->config();
-        }
-    }
-
-
-    /**
-     * @return DisplayTicketSelector
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function ticketSelector()
-    {
-        if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
-            EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(
-                EED_Ticket_Selector::getRequest(),
-                EED_Ticket_Selector::ticketConfig(),
-                EED_Events_Archive::is_iframe()
-            );
-        }
-        return EED_Ticket_Selector::$ticket_selector;
-    }
-
-
-    /**
-     * gets the ball rolling
-     *
-     * @param WP $WP
-     * @return void
-     */
-    public function run($WP)
-    {
-    }
-
-
-    /**
-     * @return TicketSelectorIframeEmbedButton
-     */
-    public static function getIframeEmbedButton()
-    {
-        if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
-            self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
-        }
-        return self::$iframe_embed_button;
-    }
-
-
-    /**
-     * ticket_selector_iframe_embed_button
-     *
-     * @return void
-     */
-    public static function ticket_selector_iframe_embed_button()
-    {
-        $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-        $iframe_embed_button->addEventEditorIframeEmbedButton();
-    }
-
-
-    /**
-     * ticket_selector_iframe
-     *
-     * @return void
-     * @throws DomainException
-     */
-    public function ticket_selector_iframe()
-    {
-        EE_Dependency_Map::register_dependencies(
-            TicketSelectorIframe::class,
-            [
-                'EEM_Event'                                            => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\CurrentPage'      => EE_Dependency_Map::load_from_cache,
-                'EventEspresso\core\services\request\RequestInterface' => EE_Dependency_Map::load_from_cache,
-            ]
-        );
-        $ticket_selector_iframe = LoaderFactory::getLoader()->getNew(TicketSelectorIframe::class);
-        $ticket_selector_iframe->display();
-    }
-
-
-    /**
-     * creates buttons for selecting number of attendees for an event
-     *
-     * @param WP_Post|int $event
-     * @param bool        $view_details
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function display_ticket_selector($event = null, $view_details = false)
-    {
-        return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
-    }
-
-
-    /**
-     * @return bool  or FALSE
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    public function process_ticket_selections()
-    {
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
-        return $form->processTicketSelections();
-    }
-
-
-    /**
-     * @return bool
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function cancel_ticket_selections()
-    {
-        /** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
-        $form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
-        return $form->cancelTicketSelections();
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function translate_js_strings()
-    {
-        EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
-            'please select a datetime',
-            'event_espresso'
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function load_tckt_slctr_assets()
-    {
-        if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
-            // add some style
-            wp_register_style(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
-                [],
-                EVENT_ESPRESSO_VERSION
-            );
-            wp_enqueue_style('ticket_selector');
-            // make it dance
-            wp_register_script(
-                'ticket_selector',
-                TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
-                ['espresso_core'],
-                EVENT_ESPRESSO_VERSION,
-                true
-            );
-            wp_enqueue_script('ticket_selector');
-            require_once EE_LIBRARIES
-                         . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
-            EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
-        }
-    }
-
-
-    /**
-     * @return void
-     */
-    public static function loadIframeAssets()
-    {
-        // for event lists
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
-            ['EED_Ticket_Selector', 'iframeCss']
-        );
-        add_filter(
-            'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
-            ['EED_Ticket_Selector', 'iframeJs']
-        );
-        // for ticket selectors
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
-            ['EED_Ticket_Selector', 'iframeCss']
-        );
-        add_filter(
-            'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
-            ['EED_Ticket_Selector', 'iframeJs']
-        );
-    }
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_css
-     * @return array
-     */
-    public static function iframeCss(array $iframe_css)
-    {
-        $iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
-        return $iframe_css;
-    }
-
-
-    /**
-     * Informs the rest of the forms system what CSS and JS is needed to display the input
-     *
-     * @param array $iframe_js
-     * @return array
-     */
-    public static function iframeJs(array $iframe_js)
-    {
-        $iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
-        return $iframe_js;
-    }
-
-
-    /****************************** DEPRECATED ******************************/
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function display_view_details_btn()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function display_ticket_selector_submit()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
-    }
-
-
-    /**
-     * @param string $permalink_string
-     * @param int    $id
-     * @param string $new_title
-     * @param string $new_slug
-     * @return string
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @deprecated
-     */
-    public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
-    {
-        $request = self::getRequest();
-        // todo add doing_it_wrong() notice during next major version
-        if (
-            $request->getRequestParam('page') === 'espresso_events'
-            && $request->getRequestParam('action') === 'edit'
-        ) {
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->addEventEditorIframeEmbedButton();
-        }
-        return '';
-    }
-
-
-    /**
-     * @param int    $ID
-     * @param string $external_url
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function ticket_selector_form_open($ID = 0, $external_url = '')
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function ticket_selector_form_close()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->formClose();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function no_tkt_slctr_end_dv()
-    {
-        // todo add doing_it_wrong() notice during next major version
-        return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated 4.9.13
-     */
-    public static function tkt_slctr_end_dv()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @deprecated
-     */
-    public static function clear_tkt_slctr()
-    {
-        return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
-    }
-
-
-    /**
-     * @deprecated
-     */
-    public static function load_tckt_slctr_assets_admin()
-    {
-        $request = self::getRequest();
-        // todo add doing_it_wrong() notice during next major version
-        if (
-            $request->getRequestParam('page') === 'espresso_events'
-            && $request->getRequestParam('action') === 'edit'
-        ) {
-            $iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
-            $iframe_embed_button->embedButtonAssets();
-        }
-    }
+	/**
+	 * @var DisplayTicketSelector $ticket_selector
+	 */
+	private static $ticket_selector;
+
+	/**
+	 * @var TicketSelectorIframeEmbedButton $iframe_embed_button
+	 */
+	private static $iframe_embed_button;
+
+
+	/**
+	 * @return EED_Module|EED_Ticket_Selector
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function instance()
+	{
+		return parent::get_instance(__CLASS__);
+	}
+
+
+	/**
+	 * @return EE_Ticket_Selector_Config
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function ticketConfig()
+	{
+		EED_Ticket_Selector::instance()->set_config();
+		return EED_Ticket_Selector::instance()->config();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	protected function set_config()
+	{
+		if ($this->_config instanceof EE_Ticket_Selector_Config) {
+			return;
+		}
+		$this->set_config_section('template_settings');
+		$this->set_config_class('EE_Ticket_Selector_Config');
+		$this->set_config_name('EED_Ticket_Selector');
+	}
+
+
+	/**
+	 *    set_hooks - for hooking into EE Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks()
+	{
+		// routing
+		EE_Config::register_route(
+			'iframe',
+			'EED_Ticket_Selector',
+			'ticket_selector_iframe',
+			'ticket_selector'
+		);
+		EE_Config::register_route(
+			'process_ticket_selections',
+			'EED_Ticket_Selector',
+			'process_ticket_selections'
+		);
+		EE_Config::register_route(
+			'cancel_ticket_selections',
+			'EED_Ticket_Selector',
+			'cancel_ticket_selections'
+		);
+		add_action('wp_loaded', ['EED_Ticket_Selector', 'set_definitions'], 2);
+		add_action('AHEE_event_details_header_bottom', ['EED_Ticket_Selector', 'display_ticket_selector'], 10, 1);
+		add_action('wp_enqueue_scripts', ['EED_Ticket_Selector', 'translate_js_strings'], 0);
+		add_action('wp_enqueue_scripts', ['EED_Ticket_Selector', 'load_tckt_slctr_assets'], 10);
+		EED_Ticket_Selector::loadIframeAssets();
+	}
+
+
+	/**
+	 *    set_hooks_admin - for hooking into EE Admin Core, other modules, etc
+	 *
+	 * @return void
+	 */
+	public static function set_hooks_admin()
+	{
+		// hook into the end of the \EE_Admin_Page::_load_page_dependencies()
+		// to load assets for "espresso_events" page on the "edit" route (action)
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_events__edit',
+			['EED_Ticket_Selector', 'ticket_selector_iframe_embed_button'],
+			10
+		);
+		/**
+		 * Make sure assets for the ticket selector are loaded on the espresso registrations route so  admin side
+		 * registrations work.
+		 */
+		add_action(
+			'FHEE__EE_Admin_Page___load_page_dependencies__after_load__espresso_registrations__new_registration',
+			['EED_Ticket_Selector', 'set_definitions'],
+			10
+		);
+	}
+
+
+	/**
+	 *    set_definitions
+	 *
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function set_definitions()
+	{
+		// don't do this twice
+		if (defined('TICKET_SELECTOR_ASSETS_URL')) {
+			return;
+		}
+		define('TICKET_SELECTOR_ASSETS_URL', plugin_dir_url(__FILE__) . 'assets/');
+		define(
+			'TICKET_SELECTOR_TEMPLATES_PATH',
+			str_replace('\\', '/', plugin_dir_path(__FILE__)) . 'templates/'
+		);
+		// initialize config
+		EED_Ticket_Selector::instance()->set_config();
+		// if config is not set, initialize
+		if (
+			! EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector instanceof EE_Ticket_Selector_Config
+		) {
+			EED_Ticket_Selector::instance()->set_config();
+			EE_Registry::instance()->CFG->template_settings->EED_Ticket_Selector =
+				EED_Ticket_Selector::instance()->config();
+		}
+	}
+
+
+	/**
+	 * @return DisplayTicketSelector
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function ticketSelector()
+	{
+		if (! EED_Ticket_Selector::$ticket_selector instanceof DisplayTicketSelector) {
+			EED_Ticket_Selector::$ticket_selector = new DisplayTicketSelector(
+				EED_Ticket_Selector::getRequest(),
+				EED_Ticket_Selector::ticketConfig(),
+				EED_Events_Archive::is_iframe()
+			);
+		}
+		return EED_Ticket_Selector::$ticket_selector;
+	}
+
+
+	/**
+	 * gets the ball rolling
+	 *
+	 * @param WP $WP
+	 * @return void
+	 */
+	public function run($WP)
+	{
+	}
+
+
+	/**
+	 * @return TicketSelectorIframeEmbedButton
+	 */
+	public static function getIframeEmbedButton()
+	{
+		if (! self::$iframe_embed_button instanceof TicketSelectorIframeEmbedButton) {
+			self::$iframe_embed_button = new TicketSelectorIframeEmbedButton();
+		}
+		return self::$iframe_embed_button;
+	}
+
+
+	/**
+	 * ticket_selector_iframe_embed_button
+	 *
+	 * @return void
+	 */
+	public static function ticket_selector_iframe_embed_button()
+	{
+		$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+		$iframe_embed_button->addEventEditorIframeEmbedButton();
+	}
+
+
+	/**
+	 * ticket_selector_iframe
+	 *
+	 * @return void
+	 * @throws DomainException
+	 */
+	public function ticket_selector_iframe()
+	{
+		EE_Dependency_Map::register_dependencies(
+			TicketSelectorIframe::class,
+			[
+				'EEM_Event'                                            => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\CurrentPage'      => EE_Dependency_Map::load_from_cache,
+				'EventEspresso\core\services\request\RequestInterface' => EE_Dependency_Map::load_from_cache,
+			]
+		);
+		$ticket_selector_iframe = LoaderFactory::getLoader()->getNew(TicketSelectorIframe::class);
+		$ticket_selector_iframe->display();
+	}
+
+
+	/**
+	 * creates buttons for selecting number of attendees for an event
+	 *
+	 * @param WP_Post|int $event
+	 * @param bool        $view_details
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function display_ticket_selector($event = null, $view_details = false)
+	{
+		return EED_Ticket_Selector::ticketSelector()->display($event, $view_details);
+	}
+
+
+	/**
+	 * @return bool  or FALSE
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	public function process_ticket_selections()
+	{
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
+		return $form->processTicketSelections();
+	}
+
+
+	/**
+	 * @return bool
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function cancel_ticket_selections()
+	{
+		/** @var EventEspresso\modules\ticket_selector\ProcessTicketSelector $form */
+		$form = LoaderFactory::getLoader()->getShared('EventEspresso\modules\ticket_selector\ProcessTicketSelector');
+		return $form->cancelTicketSelections();
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function translate_js_strings()
+	{
+		EE_Registry::$i18n_js_strings['please_select_date_filter_notice'] = esc_html__(
+			'please select a datetime',
+			'event_espresso'
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function load_tckt_slctr_assets()
+	{
+		if (apply_filters('FHEE__EED_Ticket_Selector__load_tckt_slctr_assets', false)) {
+			// add some style
+			wp_register_style(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css',
+				[],
+				EVENT_ESPRESSO_VERSION
+			);
+			wp_enqueue_style('ticket_selector');
+			// make it dance
+			wp_register_script(
+				'ticket_selector',
+				TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js',
+				['espresso_core'],
+				EVENT_ESPRESSO_VERSION,
+				true
+			);
+			wp_enqueue_script('ticket_selector');
+			require_once EE_LIBRARIES
+						 . 'form_sections/strategies/display/EE_Checkbox_Dropdown_Selector_Display_Strategy.strategy.php';
+			EE_Checkbox_Dropdown_Selector_Display_Strategy::enqueue_styles_and_scripts();
+		}
+	}
+
+
+	/**
+	 * @return void
+	 */
+	public static function loadIframeAssets()
+	{
+		// for event lists
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__css',
+			['EED_Ticket_Selector', 'iframeCss']
+		);
+		add_filter(
+			'FHEE__EventEspresso_modules_events_archive_EventsArchiveIframe__display__js',
+			['EED_Ticket_Selector', 'iframeJs']
+		);
+		// for ticket selectors
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__css',
+			['EED_Ticket_Selector', 'iframeCss']
+		);
+		add_filter(
+			'FHEE__EED_Ticket_Selector__ticket_selector_iframe__js',
+			['EED_Ticket_Selector', 'iframeJs']
+		);
+	}
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_css
+	 * @return array
+	 */
+	public static function iframeCss(array $iframe_css)
+	{
+		$iframe_css['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.css';
+		return $iframe_css;
+	}
+
+
+	/**
+	 * Informs the rest of the forms system what CSS and JS is needed to display the input
+	 *
+	 * @param array $iframe_js
+	 * @return array
+	 */
+	public static function iframeJs(array $iframe_js)
+	{
+		$iframe_js['ticket_selector'] = TICKET_SELECTOR_ASSETS_URL . 'ticket_selector.js';
+		return $iframe_js;
+	}
+
+
+	/****************************** DEPRECATED ******************************/
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function display_view_details_btn()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displayViewDetailsButton();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function display_ticket_selector_submit()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->displaySubmitButton();
+	}
+
+
+	/**
+	 * @param string $permalink_string
+	 * @param int    $id
+	 * @param string $new_title
+	 * @param string $new_slug
+	 * @return string
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @deprecated
+	 */
+	public static function iframe_code_button($permalink_string, $id, $new_title = '', $new_slug = '')
+	{
+		$request = self::getRequest();
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			$request->getRequestParam('page') === 'espresso_events'
+			&& $request->getRequestParam('action') === 'edit'
+		) {
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->addEventEditorIframeEmbedButton();
+		}
+		return '';
+	}
+
+
+	/**
+	 * @param int    $ID
+	 * @param string $external_url
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function ticket_selector_form_open($ID = 0, $external_url = '')
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formOpen($ID, $external_url);
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function ticket_selector_form_close()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->formClose();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function no_tkt_slctr_end_dv()
+	{
+		// todo add doing_it_wrong() notice during next major version
+		return EED_Ticket_Selector::ticketSelector()->ticketSelectorEndDiv();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated 4.9.13
+	 */
+	public static function tkt_slctr_end_dv()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @deprecated
+	 */
+	public static function clear_tkt_slctr()
+	{
+		return EED_Ticket_Selector::ticketSelector()->clearTicketSelector();
+	}
+
+
+	/**
+	 * @deprecated
+	 */
+	public static function load_tckt_slctr_assets_admin()
+	{
+		$request = self::getRequest();
+		// todo add doing_it_wrong() notice during next major version
+		if (
+			$request->getRequestParam('page') === 'espresso_events'
+			&& $request->getRequestParam('action') === 'edit'
+		) {
+			$iframe_embed_button = EED_Ticket_Selector::getIframeEmbedButton();
+			$iframe_embed_button->embedButtonAssets();
+		}
+	}
 }

admin_pages/support/templates/support_admin_details_contact_support.template.php

Indentation +68 added lines, -68 removed lines

@@ -3,102 +3,102 @@
 
     <h4>
         <?php
-        esc_html_e(
-            'You may be able to find an answer for your question or concern here:',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'You may be able to find an answer for your question or concern here:',
+			'event_espresso'
+		);
+		?>
     </h4>
     <ol>
         <li>
             <strong><em><?php esc_html_e('A known issue.', 'event_espresso'); ?></em></strong>
             <?php
-            printf(
-                esc_html__(
-                    'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
-                    'event_espresso'
-                ),
-                '<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
-                '</a>',
-                '<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
-                '<a href="https://eventespresso.com/support/forums/" target="_blank">'
-            );
-            ?>
+			printf(
+				esc_html__(
+					'Some themes and plugins have %1$sknown conflicts%2$s with Event Espresso. (You can also browse the %3$sEvent Espresso support pages%2$s or %4$sEvent Espresso support forums%2$s to see if other members have experienced and solved the problem.)',
+					'event_espresso'
+				),
+				'<a href="https://eventespresso.com/wiki/known-third-party-plugin-theme-conflicts/" target="_blank">',
+				'</a>',
+				'<a href="https://eventespresso.com/support/documentation/versioned-docs/?doc_ver=ee4" target="_blank">',
+				'<a href="https://eventespresso.com/support/forums/" target="_blank">'
+			);
+			?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A plugin conflict.', 'event_espresso'); ?></em></strong>
             <?php
-            esc_html_e(
-                'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
-                'event_espresso'
-            );
-            ?>
+			esc_html_e(
+				'You can check to see if there is a plugin conflict by temporarily deactivating all plugins except for Event Espresso. If the problem goes away, then reactivate your plugins one by one until the issue returns. This will help you pinpoint the source of the conflict.',
+				'event_espresso'
+			);
+			?>
         </li>
         <li>
             <strong><em><?php esc_html_e('A theme conflict.', 'event_espresso'); ?></em></strong>
             <?php
-            $default_theme = wp_get_theme(WP_DEFAULT_THEME);
+			$default_theme = wp_get_theme(WP_DEFAULT_THEME);
 
-            if ($default_theme->exists()) {
-                printf(
-                    esc_html__(
-                        'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
-                        'event_espresso'
-                    ),
-                    $default_theme->get('Name')
-                );
-            } else {
-                esc_html_e(
-                    'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
-                    'event_espresso'
-                );
-            }
-            ?>
+			if ($default_theme->exists()) {
+				printf(
+					esc_html__(
+						'If your problem is not a known issue or caused by a plugin, then try activating %s (the default WordPress theme).',
+						'event_espresso'
+					),
+					$default_theme->get('Name')
+				);
+			} else {
+				esc_html_e(
+					'If your problem is not a known issue or caused by a plugin, then try activating the default WordPress theme.',
+					'event_espresso'
+				);
+			}
+			?>
             <?php
-            esc_html_e(
-                'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
-                'event_espresso'
-            );
-            ?>
+			esc_html_e(
+				'If this solves the problem for you, then something in your theme is causing this issue. Check to see if an update is available for your WordPress theme or reach out to the theme author.',
+				'event_espresso'
+			);
+			?>
         </li>
     </ol>
 
     <p>
         <?php
-        esc_html_e(
-            'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'If none of the suggestions above help you find a solution, then feel free to reach out to the support team at Event Espresso.',
+			'event_espresso'
+		);
+		?>
     </p>
     <p>
         <?php
-        printf(
-            esc_html__(
-                'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/support/forums/" target="_blank">',
-            '</a>',
-            '<strong>',
-            '</strong>',
-            '<a href="#espresso_important_information_settings">'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Login to your account on EventEspresso.com and %1$screate a support post in our member support forums%2$s. Use a %3$sclear and descriptive title%4$s in your support post, %3$sdescribe the issue to the best of your knowledge%4$s, and %3$snever post any sensitive information such as login details%4$s. Be sure to also include %5$simportant information in the section below%2$s about your WordPress site.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/support/forums/" target="_blank">',
+			'</a>',
+			'<strong>',
+			'</strong>',
+			'<a href="#espresso_important_information_settings">'
+		);
+		?>
     </p>
 
     <h4><?php esc_html_e('Have an emergency?', 'event_espresso'); ?></h4>
 
     <p>
         <?php
-        printf(
-            esc_html__(
-                'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'We offer support tokens to members that need help with a time-sensitive issue. A support token will provide you with up to 30 minutes of one-on-one time with a team member at Event Espresso. If you have an emergency and need help quickly, then please %1$spurchase a support token%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://eventespresso.com/product/premium-support-token/?utm_source=ee4_plugin_admin&utm_medium=link&utm_campaign=help_support_tab&utm_content=support_token" target="_blank">',
+			'</a>'
+		);
+		?>
     </p>
 </div>
\ No newline at end of file

admin_pages/registration_form/Registration_Form_Admin_Page.core.php

Spacing +30 added lines, -30 removed lines

@@ -53,8 +53,8 @@ 
      */
     public function __construct($routing = true)
     {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+        require_once(EE_MODELS.'EEM_Question.model.php');
+        require_once(EE_MODELS.'EEM_Question_Group.model.php');
         $this->_question_model       = EEM_Question::instance();
         $this->_question_group_model = EEM_Question_Group::instance();
         parent::__construct($routing);
@@ -91,7 +91,7 @@ 
      */
     protected function _set_page_routes()
     {
-        $qst_id             =
+        $qst_id =
             ! empty($this->_req_data['QST_ID'])
                 ? $this->_req_data['QST_ID']
                 : 0;
@@ -234,7 +234,7 @@ 
     {
         wp_register_style(
             'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.css',
             [],
             EVENT_ESPRESSO_VERSION
         );
@@ -291,7 +291,7 @@ 
         $this->load_scripts_styles_forms();
         wp_register_script(
             'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+            REGISTRATION_FORM_ASSETS_URL.'espresso_registration_form_admin.js',
             ['jquery-ui-sortable'],
             EVENT_ESPRESSO_VERSION,
             true
@@ -310,7 +310,7 @@ 
 
     public function recaptcha_info_help_tab()
     {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+        $template = REGISTRATION_FORM_TEMPLATE_PATH.'recaptcha_info_help_tab.template.php';
         EEH_Template::display_template($template, []);
     }
 
@@ -359,16 +359,16 @@ 
     {
         $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
         $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+            '<img src="'.REGISTRATION_FORM_ASSETS_URL.'caf_reg_form_preview.jpg" alt="'
             . esc_attr__(
                 'Preview Question Groups Overview List Table screenshot',
                 'event_espresso'
-            ) . '" />';
+            ).'" />';
         $this->_template_args['preview_text'] = '<strong>'
                                                 . esc_html__(
                                                     'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
                                                     'event_espresso'
-                                                ) . '</strong>';
+                                                ).'</strong>';
         $this->display_admin_caf_preview_page('question_groups_tab');
     }
 
@@ -387,7 +387,7 @@ 
 
         // some initial checks for proper values.
         // if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
+        if ( ! empty($this->_req_data['QST_admin_only'])) {
             $this->_req_data['QST_required'] = 0;
         }
         // if the question shouldn't have a max length, don't let them set one
@@ -414,19 +414,19 @@ 
                 $QSG_name = isset($this->_req_data['QSG_name'])
                     ? $this->_req_data['QSG_name']
                     : '';
-                $set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+                $set_column_values[$fieldName] = sanitize_title($QSG_name).'-'.uniqid('', true);
             } elseif (
                 $fieldName === 'QST_admin_label'
                 && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
             ) {
                 // the admin label is blank, use a slug version of the question text
-                $QST_text                        =
+                $QST_text =
                     isset($this->_req_data['QST_display_text'])
                         ? $this->_req_data['QST_display_text']
                         : '';
-                $set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-            } elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[ $fieldName ] = 0;
+                $set_column_values[$fieldName] = sanitize_title(wp_trim_words($QST_text, 10));
+            } elseif ($fieldName === 'QST_admin_only' && ( ! isset($this->_req_data['QST_admin_only']))) {
+                $set_column_values[$fieldName] = 0;
             } elseif ($fieldName === 'QST_max') {
                 $qst_system = EEM_Question::instance()->get_var(
                     [
@@ -438,23 +438,23 @@ 
                     ],
                     'QST_system'
                 );
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+                $max_max = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
                 if (
                     empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
                 ) {
-                    $set_column_values[ $fieldName ] = $max_max;
+                    $set_column_values[$fieldName] = $max_max;
                 }
             }
 
 
             // only add a property to the array if it's not null (otherwise the model should just use the default value)
             if (
-                ! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
+                ! isset($set_column_values[$fieldName]) && isset($this->_req_data[$fieldName])
             ) {
-                $set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
+                $set_column_values[$fieldName] = $this->_req_data[$fieldName];
             }
         }
-        return $set_column_values;// validation fo this data to be performed by the model before insertion.
+        return $set_column_values; // validation fo this data to be performed by the model before insertion.
     }
 
 
@@ -496,7 +496,7 @@ 
         // add PRC_ID to title if editing
         $this->_admin_page_title =
             $ID
-                ? $this->_admin_page_title . ' # ' . $ID
+                ? $this->_admin_page_title.' # '.$ID
                 : $this->_admin_page_title;
         if ($ID) {
             $question                 = $this->_question_model->get_one_by_ID($ID);
@@ -532,7 +532,7 @@ 
         $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
         $this->_set_publish_post_box_vars('id', $ID);
         $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+            REGISTRATION_FORM_TEMPLATE_PATH.'questions_main_meta_box.template.php',
             $this->_template_args,
             true
         );
@@ -554,7 +554,7 @@ 
         $question_type_descriptions = EEM_Question::instance()->question_descriptions();
         foreach ($question_type_descriptions as $type => $question_type_description) {
             if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
+                $html = new EE_Simple_HTML_Validation_Strategy();
                 $question_type_description .= sprintf(
                     esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
                     '<br/>',
@@ -563,7 +563,7 @@ 
             }
             $descriptions .= EEH_HTML::p(
                 $question_type_description,
-                'question_type_description-' . $type,
+                'question_type_description-'.$type,
                 'question_type_description description',
                 'display:none;'
             );
@@ -598,11 +598,11 @@ 
             // trash removed options, save old ones
             // get list of all options
             $options = $question->options();
-            if (! empty($options)) {
+            if ( ! empty($options)) {
                 foreach ($options as $option_ID => $option) {
                     $option_req_index = $this->_get_option_req_data_index($option_ID);
                     if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][ $option_req_index ]);
+                        $option->save($this->_req_data['question_options'][$option_req_index]);
                     } else {
                         // not found, remove it
                         $option->delete();
@@ -693,11 +693,11 @@ 
             (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
                 ? $this->_req_data['order']
                 : 'ASC';
-        $orderby_field            =
+        $orderby_field =
             $model instanceof EEM_Question
                 ? 'QST_ID'
                 : 'QSG_order';
-        $field_to_order_by        =
+        $field_to_order_by =
             empty($this->_req_data['orderby'])
                 ? $orderby_field
                 : $this->_req_data['orderby'];
@@ -706,7 +706,7 @@ 
             array_key_exists('s', $this->_req_data)
                 ? $this->_req_data['s']
                 : null;
-        if (! empty($search_string)) {
+        if ( ! empty($search_string)) {
             if ($model instanceof EEM_Question_Group) {
                 $query_params[0] = [
                     'OR' => [
@@ -768,7 +768,7 @@ 
         $QST          = EEM_Question::instance();
         $query_params = $this->get_query_params($QST, $per_page, $current_page);
         if ($count) {
-            $where   =
+            $where =
                 isset($query_params[0])
                     ? [$query_params[0]]
                     : [];

Indentation +764 added lines, -764 removed lines

@@ -15,707 +15,707 @@ 
  */
 class Registration_Form_Admin_Page extends EE_Admin_Page
 {
-    /**
-     * holds the specific question object for the question details screen
-     *
-     * @var EE_Question $_question
-     */
-    protected $_question;
-
-    /**
-     * holds the specific question group object for the question group details screen
-     *
-     * @var EE_Question_Group $_question_group
-     */
-    protected $_question_group;
-
-    /**
-     *_question_model EEM_Question model instance (for queries)
-     *
-     * @var EEM_Question $_question_model ;
-     */
-    protected $_question_model;
-
-    /**
-     * _question_group_model EEM_Question_group instance (for queries)
-     *
-     * @var EEM_Question_Group $_question_group_model
-     */
-    protected $_question_group_model;
-
-
-    /**
-     * @Constructor
-     * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($routing = true)
-    {
-        require_once(EE_MODELS . 'EEM_Question.model.php');
-        require_once(EE_MODELS . 'EEM_Question_Group.model.php');
-        $this->_question_model       = EEM_Question::instance();
-        $this->_question_group_model = EEM_Question_Group::instance();
-        parent::__construct($routing);
-    }
-
-
-    protected function _init_page_props()
-    {
-        $this->page_slug        = REGISTRATION_FORM_PG_SLUG;
-        $this->page_label       = esc_html__('Registration Form', 'event_espresso');
-        $this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
-        $this->_admin_base_path = REGISTRATION_FORM_ADMIN;
-    }
-
-
-    protected function _ajax_hooks()
-    {
-    }
-
-
-    protected function _define_page_props()
-    {
-        $this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
-        $this->_labels           = [
-            'buttons' => [
-                'edit_question' => esc_html__('Edit Question', 'event_espresso'),
-            ],
-        ];
-    }
-
-
-    /**
-     *_set_page_routes
-     */
-    protected function _set_page_routes()
-    {
-        $qst_id             =
-            ! empty($this->_req_data['QST_ID'])
-                ? $this->_req_data['QST_ID']
-                : 0;
-        $this->_page_routes = [
-            'default' => [
-                'func'       => '_questions_overview_list_table',
-                'capability' => 'ee_read_questions',
-            ],
-
-            'edit_question' => [
-                'func'       => '_edit_question',
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'args'       => ['edit'],
-            ],
-
-            'question_groups' => [
-                'func'       => '_questions_groups_preview',
-                'capability' => 'ee_read_question_groups',
-            ],
-
-            'update_question' => [
-                'func'       => '_insert_or_update_question',
-                'args'       => ['new_question' => false],
-                'capability' => 'ee_edit_question',
-                'obj_id'     => $qst_id,
-                'noheader'   => true,
-            ],
-        ];
-    }
-
-
-    protected function _set_page_config()
-    {
-        $this->_page_config = [
-            'default' => [
-                'nav'           => [
-                    'label' => esc_html__('Questions', 'event_espresso'),
-                    'order' => 10,
-                ],
-                'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_questions_overview_help_tab'                           => [
-                        'title'    => esc_html__('Questions Overview', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview',
-                    ],
-                    'registration_form_questions_overview_table_column_headings_help_tab'     => [
-                        'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_table_column_headings',
-                    ],
-                    'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
-                        'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
-                        'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
-                    ],
-                ],
-                'require_nonce' => false,
-                'qtips'         => [
-                    'EE_Registration_Form_Tips',
-                ]/**/
-            ],
-
-            'question_groups' => [
-                'nav'           => [
-                    'label' => esc_html__('Question Groups', 'event_espresso'),
-                    'order' => 20,
-                ],
-                'metaboxes'     => $this->_default_espresso_metaboxes,
-                'help_tabs'     => [
-                    'registration_form_question_groups_help_tab' => [
-                        'title'    => esc_html__('Question Groups', 'event_espresso'),
-                        'filename' => 'registration_form_question_groups',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-
-            'edit_question' => [
-                'nav'           => [
-                    'label'      => esc_html__('Edit Question', 'event_espresso'),
-                    'order'      => 15,
-                    'persistent' => false,
-                    'url'        => isset($this->_req_data['question_id'])
-                        ? add_query_arg(
-                            ['question_id' => $this->_req_data['question_id']],
-                            $this->_current_page_view_url
-                        )
-                        : $this->_admin_base_url,
-                ],
-                'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
-                'help_tabs'     => [
-                    'registration_form_edit_question_group_help_tab' => [
-                        'title'    => esc_html__('Edit Question', 'event_espresso'),
-                        'filename' => 'registration_form_edit_question',
-                    ],
-                ],
-                'require_nonce' => false,
-            ],
-        ];
-    }
-
-
-    protected function _add_screen_options()
-    {
-        // todo
-    }
-
-
-    protected function _add_screen_options_default()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Questions', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    protected function _add_screen_options_question_groups()
-    {
-        $page_title              = $this->_admin_page_title;
-        $this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
-        $this->_per_page_screen_option();
-        $this->_admin_page_title = $page_title;
-    }
-
-
-    // none of the below group are currently used for Event Categories
-    protected function _add_feature_pointers()
-    {
-    }
-
-
-    public function load_scripts_styles()
-    {
-        wp_register_style(
-            'espresso_registration',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
-            [],
-            EVENT_ESPRESSO_VERSION
-        );
-        wp_enqueue_style('espresso_registration');
-    }
-
-
-    public function admin_init()
-    {
-    }
-
-
-    public function admin_notices()
-    {
-    }
-
-
-    public function admin_footer_scripts()
-    {
-    }
-
-
-    public function load_scripts_styles_default()
-    {
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_add_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * @throws EE_Error
-     */
-    public function load_scripts_styles_edit_question()
-    {
-        $this->load_scripts_styles_question_details();
-    }
-
-
-    /**
-     * Loads the JS required for adding or editing a question
-     *
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function load_scripts_styles_question_details()
-    {
-        $this->load_scripts_styles_forms();
-        wp_register_script(
-            'espresso_registration_form_single',
-            REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
-            ['jquery-ui-sortable'],
-            EVENT_ESPRESSO_VERSION,
-            true
-        );
-        wp_enqueue_script('espresso_registration_form_single');
-        wp_localize_script(
-            'espresso_registration_form_single',
-            'ee_question_data',
-            [
-                'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
-                'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
-            ]
-        );
-    }
-
-
-    public function recaptcha_info_help_tab()
-    {
-        $template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
-        EEH_Template::display_template($template, []);
-    }
-
-
-    public function load_scripts_styles_forms()
-    {
-        // styles
-        wp_enqueue_style('espresso-ui-theme');
-        // scripts
-        wp_enqueue_script('ee_admin_js');
-    }
-
-
-    protected function _set_list_table_views_default()
-    {
-        $this->_views = [
-            'all' => [
-                'slug'  => 'all',
-                'label' => esc_html__('View All Questions', 'event_espresso'),
-                'count' => 0,
-            ],
-        ];
-
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_questions',
-                'espresso_registration_form_trash_questions'
-            )
-        ) {
-            $this->_views['trash'] = [
-                'slug'  => 'trash',
-                'label' => esc_html__('Trash', 'event_espresso'),
-                'count' => 0,
-            ];
-        }
-    }
-
-
-    /**
-     * This just previews the question groups tab that comes in caffeinated.
-     *
-     * @return void html
-     * @throws EE_Error
-     */
-    protected function _questions_groups_preview()
-    {
-        $this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
-        $this->_template_args['preview_img']  =
-            '<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
-            . esc_attr__(
-                'Preview Question Groups Overview List Table screenshot',
-                'event_espresso'
-            ) . '" />';
-        $this->_template_args['preview_text'] = '<strong>'
-                                                . esc_html__(
-                                                    'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
-                                                    'event_espresso'
-                                                ) . '</strong>';
-        $this->display_admin_caf_preview_page('question_groups_tab');
-    }
-
-
-    /**
-     * Extracts the question field's values from the POST request to update or insert them
-     *
-     * @param EEM_Base $model
-     * @return array where each key is the name of a model's field/db column, and each value is its value.
-     * @throws EE_Error
-     */
-    protected function _set_column_values_for(EEM_Base $model)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = [];
-
-        // some initial checks for proper values.
-        // if QST_admin_only, then no matter what QST_required is we disable.
-        if (! empty($this->_req_data['QST_admin_only'])) {
-            $this->_req_data['QST_required'] = 0;
-        }
-        // if the question shouldn't have a max length, don't let them set one
-        if (
-            ! isset(
-                $this->_req_data['QST_type'],
-                $this->_req_data['QST_max']
-            )
-            || ! in_array(
-                $this->_req_data['QST_type'],
-                EEM_Question::instance()->questionTypesWithMaxLength(),
-                true
-            )
-        ) {
-            // they're not allowed to set the max
-            $this->_req_data['QST_max'] = null;
-        }
-        foreach ($model->field_settings() as $fieldName => $settings) {
-            // basically if QSG_identifier is empty or not set
-            if (
-                $fieldName === 'QSG_identifier'
-                && (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
-            ) {
-                $QSG_name = isset($this->_req_data['QSG_name'])
-                    ? $this->_req_data['QSG_name']
-                    : '';
-                $set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
-            } elseif (
-                $fieldName === 'QST_admin_label'
-                && (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
-            ) {
-                // the admin label is blank, use a slug version of the question text
-                $QST_text                        =
-                    isset($this->_req_data['QST_display_text'])
-                        ? $this->_req_data['QST_display_text']
-                        : '';
-                $set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
-            } elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
-                $set_column_values[ $fieldName ] = 0;
-            } elseif ($fieldName === 'QST_max') {
-                $qst_system = EEM_Question::instance()->get_var(
-                    [
-                        [
-                            'QST_ID' => isset($this->_req_data['QST_ID'])
-                                ? $this->_req_data['QST_ID']
-                                : 0,
-                        ],
-                    ],
-                    'QST_system'
-                );
-                $max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
-                if (
-                    empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
-                ) {
-                    $set_column_values[ $fieldName ] = $max_max;
-                }
-            }
-
-
-            // only add a property to the array if it's not null (otherwise the model should just use the default value)
-            if (
-                ! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
-            ) {
-                $set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
-            }
-        }
-        return $set_column_values;// validation fo this data to be performed by the model before insertion.
-    }
-
-
-    /**
-     *_questions_overview_list_table
-     *
-     * @throws EE_Error
-     */
-    protected function _questions_overview_list_table()
-    {
-        $this->_search_btn_label = esc_html__('Questions', 'event_espresso');
-        $this->display_admin_list_table_page_with_sidebar();
-    }
-
-
-    /**
-     * _edit_question
-     *
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _edit_question()
-    {
-        $ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
-            ? absint($this->_req_data['QST_ID'])
-            : false;
-
-        switch ($this->_req_action) {
-            case 'add_question':
-                $this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
-                break;
-            case 'edit_question':
-                $this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
-                break;
-            default:
-                $this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
-        }
-
-        // add PRC_ID to title if editing
-        $this->_admin_page_title =
-            $ID
-                ? $this->_admin_page_title . ' # ' . $ID
-                : $this->_admin_page_title;
-        if ($ID) {
-            $question                 = $this->_question_model->get_one_by_ID($ID);
-            $additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
-            $this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
-        } else {
-            $question = EE_Question::new_instance();
-            $question->set_order_to_latest();
-            $this->_set_add_edit_form_tags('insert_question');
-        }
-        if ($question->system_ID() === EEM_Attendee::system_question_phone) {
-            $question_types = array_intersect_key(
-                EEM_Question::instance()->allowed_question_types(),
-                array_flip(
-                    [
-                        EEM_Question::QST_type_text,
-                        EEM_Question::QST_type_us_phone,
-                    ]
-                )
-            );
-        } else {
-            $question_types = $question->has_answers()
-                ? $this->_question_model->question_types_in_same_category($question->type())
-                : $this->_question_model->allowed_question_types();
-        }
-        $this->_template_args['QST_ID']                     = $ID;
-        $this->_template_args['question']                   = $question;
-        $this->_template_args['question_types']             = $question_types;
-        $this->_template_args['max_max']                    =
-            EEM_Question::instance()->absolute_max_for_system_question(
-                $question->system_ID()
-            );
-        $this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
-        $this->_set_publish_post_box_vars('id', $ID);
-        $this->_template_args['admin_page_content'] = EEH_Template::display_template(
-            REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
-            $this->_template_args,
-            true
-        );
-
-        // the details template wrapper
-        $this->display_admin_page_with_sidebar();
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_type_descriptions()
-    {
-        EE_Registry::instance()->load_helper('HTML');
-        $descriptions               = '';
-        $question_type_descriptions = EEM_Question::instance()->question_descriptions();
-        foreach ($question_type_descriptions as $type => $question_type_description) {
-            if ($type == 'HTML_TEXTAREA') {
-                $html                      = new EE_Simple_HTML_Validation_Strategy();
-                $question_type_description .= sprintf(
-                    esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
-                    '<br/>',
-                    $html->get_list_of_allowed_tags()
-                );
-            }
-            $descriptions .= EEH_HTML::p(
-                $question_type_description,
-                'question_type_description-' . $type,
-                'question_type_description description',
-                'display:none;'
-            );
-        }
-        return $descriptions;
-    }
-
-
-    /**
-     * @param bool|true $new_question
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _insert_or_update_question($new_question = true)
-    {
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        $set_column_values = $this->_set_column_values_for($this->_question_model);
-        if ($new_question) {
-            $question    = EE_Question::new_instance($set_column_values);
-            $action_desc = 'added';
-        } else {
-            $question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
-            foreach ($set_column_values as $field => $new_value) {
-                $question->set($field, $new_value);
-            }
-            $action_desc = 'updated';
-        }
-        $success = $question->save();
-        $ID      = $question->ID();
-        if ($ID && $question->should_have_question_options()) {
-            // save the related options
-            // trash removed options, save old ones
-            // get list of all options
-            $options = $question->options();
-            if (! empty($options)) {
-                foreach ($options as $option_ID => $option) {
-                    $option_req_index = $this->_get_option_req_data_index($option_ID);
-                    if ($option_req_index !== false) {
-                        $option->save($this->_req_data['question_options'][ $option_req_index ]);
-                    } else {
-                        // not found, remove it
-                        $option->delete();
-                    }
-                }
-            }
-            // save new related options
-            foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
-                // skip $index that is from our sample
-                if ($index === 'xxcountxx') {
-                    continue;
-                }
-                // note we allow saving blank options.
-                if (empty($option_req_data['QSO_ID'])) {
-                    // no ID! save it!
-                    $new_option = EE_Question_Option::new_instance(
-                        [
-                            'QSO_value' => $option_req_data['QSO_value'],
-                            'QSO_desc'  => $option_req_data['QSO_desc'],
-                            'QSO_order' => $option_req_data['QSO_order'],
-                            'QST_ID'    => $question->ID(),
-                        ]
-                    );
-                    $new_option->save();
-                }
-            }
-        }
-        $query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
-        if ($success !== 0) {
-            $msg = $new_question
-                ? sprintf(
-                    esc_html__('The %s has been created', 'event_espresso'),
-                    $this->_question_model->item_name()
-                )
-                : sprintf(
-                    esc_html__('The %s has been updated', 'event_espresso'),
-                    $this->_question_model->item_name()
-                );
-            EE_Error::add_success($msg);
-        }
-
-        $this->_redirect_after_action(false, '', $action_desc, $query_args, true);
-    }
-
-
-    /**
-     * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
-     * by ID
-     * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
-     * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
-     *
-     * @param int $ID of the question option to find
-     * @return int index in question_options array if successful, FALSE if unsuccessful
-     */
-    protected function _get_option_req_data_index($ID)
-    {
-        $req_data_for_question_options = $this->_req_data['question_options'];
-        foreach ($req_data_for_question_options as $num => $option_data) {
-            if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
-                return $num;
-            }
-        }
-        return false;
-    }
-
-
-
-
-    /***********/
-    /* QUERIES */
-    /**
-     * For internal use in getting all the query parameters
-     * (because it's pretty well the same between question, question groups,
-     * and for both when searching for trashed and untrashed ones)
-     *
-     * @param EEM_Base $model either EEM_Question or EEM_Question_Group
-     * @param int      $per_page
-     * @param int      $current_page
-     * @return array model query params, @see
-     *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function get_query_params($model, $per_page = 10, $current_page = 10)
-    {
-        $query_params             = [];
-        $offset                   = ($current_page - 1) * $per_page;
-        $query_params['limit']    = [$offset, $per_page];
-        $order                    =
-            (isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
-                ? $this->_req_data['order']
-                : 'ASC';
-        $orderby_field            =
-            $model instanceof EEM_Question
-                ? 'QST_ID'
-                : 'QSG_order';
-        $field_to_order_by        =
-            empty($this->_req_data['orderby'])
-                ? $orderby_field
-                : $this->_req_data['orderby'];
-        $query_params['order_by'] = [$field_to_order_by => $order];
-        $search_string            =
-            array_key_exists('s', $this->_req_data)
-                ? $this->_req_data['s']
-                : null;
-        if (! empty($search_string)) {
-            if ($model instanceof EEM_Question_Group) {
-                $query_params[0] = [
-                    'OR' => [
-                        'QSG_name' => ['LIKE', "%$search_string%"],
-                        'QSG_desc' => ['LIKE', "%$search_string%"],
-                    ],
-                ];
-            } else {
-                $query_params[0] = [
-                    'QST_display_text' => ['LIKE', "%$search_string%"],
-                ];
-            }
-        }
-
-        // capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
-        /*if ( $model instanceof EEM_Question_Group ) {
+	/**
+	 * holds the specific question object for the question details screen
+	 *
+	 * @var EE_Question $_question
+	 */
+	protected $_question;
+
+	/**
+	 * holds the specific question group object for the question group details screen
+	 *
+	 * @var EE_Question_Group $_question_group
+	 */
+	protected $_question_group;
+
+	/**
+	 *_question_model EEM_Question model instance (for queries)
+	 *
+	 * @var EEM_Question $_question_model ;
+	 */
+	protected $_question_model;
+
+	/**
+	 * _question_group_model EEM_Question_group instance (for queries)
+	 *
+	 * @var EEM_Question_Group $_question_group_model
+	 */
+	protected $_question_group_model;
+
+
+	/**
+	 * @Constructor
+	 * @param bool $routing indicate whether we want to just load the object and handle routing or just load the object.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($routing = true)
+	{
+		require_once(EE_MODELS . 'EEM_Question.model.php');
+		require_once(EE_MODELS . 'EEM_Question_Group.model.php');
+		$this->_question_model       = EEM_Question::instance();
+		$this->_question_group_model = EEM_Question_Group::instance();
+		parent::__construct($routing);
+	}
+
+
+	protected function _init_page_props()
+	{
+		$this->page_slug        = REGISTRATION_FORM_PG_SLUG;
+		$this->page_label       = esc_html__('Registration Form', 'event_espresso');
+		$this->_admin_base_url  = REGISTRATION_FORM_ADMIN_URL;
+		$this->_admin_base_path = REGISTRATION_FORM_ADMIN;
+	}
+
+
+	protected function _ajax_hooks()
+	{
+	}
+
+
+	protected function _define_page_props()
+	{
+		$this->_admin_page_title = esc_html__('Registration Form', 'event_espresso');
+		$this->_labels           = [
+			'buttons' => [
+				'edit_question' => esc_html__('Edit Question', 'event_espresso'),
+			],
+		];
+	}
+
+
+	/**
+	 *_set_page_routes
+	 */
+	protected function _set_page_routes()
+	{
+		$qst_id             =
+			! empty($this->_req_data['QST_ID'])
+				? $this->_req_data['QST_ID']
+				: 0;
+		$this->_page_routes = [
+			'default' => [
+				'func'       => '_questions_overview_list_table',
+				'capability' => 'ee_read_questions',
+			],
+
+			'edit_question' => [
+				'func'       => '_edit_question',
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'args'       => ['edit'],
+			],
+
+			'question_groups' => [
+				'func'       => '_questions_groups_preview',
+				'capability' => 'ee_read_question_groups',
+			],
+
+			'update_question' => [
+				'func'       => '_insert_or_update_question',
+				'args'       => ['new_question' => false],
+				'capability' => 'ee_edit_question',
+				'obj_id'     => $qst_id,
+				'noheader'   => true,
+			],
+		];
+	}
+
+
+	protected function _set_page_config()
+	{
+		$this->_page_config = [
+			'default' => [
+				'nav'           => [
+					'label' => esc_html__('Questions', 'event_espresso'),
+					'order' => 10,
+				],
+				'list_table'    => 'Registration_Form_Questions_Admin_List_Table',
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_questions_overview_help_tab'                           => [
+						'title'    => esc_html__('Questions Overview', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview',
+					],
+					'registration_form_questions_overview_table_column_headings_help_tab'     => [
+						'title'    => esc_html__('Questions Overview Table Column Headings', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_table_column_headings',
+					],
+					'registration_form_questions_overview_views_bulk_actions_search_help_tab' => [
+						'title'    => esc_html__('Question Overview Views & Bulk Actions & Search', 'event_espresso'),
+						'filename' => 'registration_form_questions_overview_views_bulk_actions_search',
+					],
+				],
+				'require_nonce' => false,
+				'qtips'         => [
+					'EE_Registration_Form_Tips',
+				]/**/
+			],
+
+			'question_groups' => [
+				'nav'           => [
+					'label' => esc_html__('Question Groups', 'event_espresso'),
+					'order' => 20,
+				],
+				'metaboxes'     => $this->_default_espresso_metaboxes,
+				'help_tabs'     => [
+					'registration_form_question_groups_help_tab' => [
+						'title'    => esc_html__('Question Groups', 'event_espresso'),
+						'filename' => 'registration_form_question_groups',
+					],
+				],
+				'require_nonce' => false,
+			],
+
+			'edit_question' => [
+				'nav'           => [
+					'label'      => esc_html__('Edit Question', 'event_espresso'),
+					'order'      => 15,
+					'persistent' => false,
+					'url'        => isset($this->_req_data['question_id'])
+						? add_query_arg(
+							['question_id' => $this->_req_data['question_id']],
+							$this->_current_page_view_url
+						)
+						: $this->_admin_base_url,
+				],
+				'metaboxes'     => array_merge($this->_default_espresso_metaboxes, ['_publish_post_box']),
+				'help_tabs'     => [
+					'registration_form_edit_question_group_help_tab' => [
+						'title'    => esc_html__('Edit Question', 'event_espresso'),
+						'filename' => 'registration_form_edit_question',
+					],
+				],
+				'require_nonce' => false,
+			],
+		];
+	}
+
+
+	protected function _add_screen_options()
+	{
+		// todo
+	}
+
+
+	protected function _add_screen_options_default()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Questions', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	protected function _add_screen_options_question_groups()
+	{
+		$page_title              = $this->_admin_page_title;
+		$this->_admin_page_title = esc_html__('Question Groups', 'event_espresso');
+		$this->_per_page_screen_option();
+		$this->_admin_page_title = $page_title;
+	}
+
+
+	// none of the below group are currently used for Event Categories
+	protected function _add_feature_pointers()
+	{
+	}
+
+
+	public function load_scripts_styles()
+	{
+		wp_register_style(
+			'espresso_registration',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.css',
+			[],
+			EVENT_ESPRESSO_VERSION
+		);
+		wp_enqueue_style('espresso_registration');
+	}
+
+
+	public function admin_init()
+	{
+	}
+
+
+	public function admin_notices()
+	{
+	}
+
+
+	public function admin_footer_scripts()
+	{
+	}
+
+
+	public function load_scripts_styles_default()
+	{
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_add_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 */
+	public function load_scripts_styles_edit_question()
+	{
+		$this->load_scripts_styles_question_details();
+	}
+
+
+	/**
+	 * Loads the JS required for adding or editing a question
+	 *
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function load_scripts_styles_question_details()
+	{
+		$this->load_scripts_styles_forms();
+		wp_register_script(
+			'espresso_registration_form_single',
+			REGISTRATION_FORM_ASSETS_URL . 'espresso_registration_form_admin.js',
+			['jquery-ui-sortable'],
+			EVENT_ESPRESSO_VERSION,
+			true
+		);
+		wp_enqueue_script('espresso_registration_form_single');
+		wp_localize_script(
+			'espresso_registration_form_single',
+			'ee_question_data',
+			[
+				'question_types_with_max'    => EEM_Question::instance()->questionTypesWithMaxLength(),
+				'question_type_with_options' => EEM_Question::instance()->question_types_with_options(),
+			]
+		);
+	}
+
+
+	public function recaptcha_info_help_tab()
+	{
+		$template = REGISTRATION_FORM_TEMPLATE_PATH . 'recaptcha_info_help_tab.template.php';
+		EEH_Template::display_template($template, []);
+	}
+
+
+	public function load_scripts_styles_forms()
+	{
+		// styles
+		wp_enqueue_style('espresso-ui-theme');
+		// scripts
+		wp_enqueue_script('ee_admin_js');
+	}
+
+
+	protected function _set_list_table_views_default()
+	{
+		$this->_views = [
+			'all' => [
+				'slug'  => 'all',
+				'label' => esc_html__('View All Questions', 'event_espresso'),
+				'count' => 0,
+			],
+		];
+
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_questions',
+				'espresso_registration_form_trash_questions'
+			)
+		) {
+			$this->_views['trash'] = [
+				'slug'  => 'trash',
+				'label' => esc_html__('Trash', 'event_espresso'),
+				'count' => 0,
+			];
+		}
+	}
+
+
+	/**
+	 * This just previews the question groups tab that comes in caffeinated.
+	 *
+	 * @return void html
+	 * @throws EE_Error
+	 */
+	protected function _questions_groups_preview()
+	{
+		$this->_admin_page_title              = esc_html__('Question Groups (Preview)', 'event_espresso');
+		$this->_template_args['preview_img']  =
+			'<img src="' . REGISTRATION_FORM_ASSETS_URL . 'caf_reg_form_preview.jpg" alt="'
+			. esc_attr__(
+				'Preview Question Groups Overview List Table screenshot',
+				'event_espresso'
+			) . '" />';
+		$this->_template_args['preview_text'] = '<strong>'
+												. esc_html__(
+													'Question Groups is a feature that is only available in the premium version of Event Espresso 4 which is available with a support license purchase on EventEspresso.com. With the Question Groups feature you are able to create new question groups, edit existing question groups, and create and edit new questions and add them to question groups.',
+													'event_espresso'
+												) . '</strong>';
+		$this->display_admin_caf_preview_page('question_groups_tab');
+	}
+
+
+	/**
+	 * Extracts the question field's values from the POST request to update or insert them
+	 *
+	 * @param EEM_Base $model
+	 * @return array where each key is the name of a model's field/db column, and each value is its value.
+	 * @throws EE_Error
+	 */
+	protected function _set_column_values_for(EEM_Base $model)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = [];
+
+		// some initial checks for proper values.
+		// if QST_admin_only, then no matter what QST_required is we disable.
+		if (! empty($this->_req_data['QST_admin_only'])) {
+			$this->_req_data['QST_required'] = 0;
+		}
+		// if the question shouldn't have a max length, don't let them set one
+		if (
+			! isset(
+				$this->_req_data['QST_type'],
+				$this->_req_data['QST_max']
+			)
+			|| ! in_array(
+				$this->_req_data['QST_type'],
+				EEM_Question::instance()->questionTypesWithMaxLength(),
+				true
+			)
+		) {
+			// they're not allowed to set the max
+			$this->_req_data['QST_max'] = null;
+		}
+		foreach ($model->field_settings() as $fieldName => $settings) {
+			// basically if QSG_identifier is empty or not set
+			if (
+				$fieldName === 'QSG_identifier'
+				&& (isset($this->_req_data['QSG_identifier']) && empty($this->_req_data['QSG_identifier']))
+			) {
+				$QSG_name = isset($this->_req_data['QSG_name'])
+					? $this->_req_data['QSG_name']
+					: '';
+				$set_column_values[ $fieldName ] = sanitize_title($QSG_name) . '-' . uniqid('', true);
+			} elseif (
+				$fieldName === 'QST_admin_label'
+				&& (isset($this->_req_data['QST_admin_label']) && empty($this->_req_data['QST_admin_label']))
+			) {
+				// the admin label is blank, use a slug version of the question text
+				$QST_text                        =
+					isset($this->_req_data['QST_display_text'])
+						? $this->_req_data['QST_display_text']
+						: '';
+				$set_column_values[ $fieldName ] = sanitize_title(wp_trim_words($QST_text, 10));
+			} elseif ($fieldName === 'QST_admin_only' && (! isset($this->_req_data['QST_admin_only']))) {
+				$set_column_values[ $fieldName ] = 0;
+			} elseif ($fieldName === 'QST_max') {
+				$qst_system = EEM_Question::instance()->get_var(
+					[
+						[
+							'QST_ID' => isset($this->_req_data['QST_ID'])
+								? $this->_req_data['QST_ID']
+								: 0,
+						],
+					],
+					'QST_system'
+				);
+				$max_max    = EEM_Question::instance()->absolute_max_for_system_question($qst_system);
+				if (
+					empty($this->_req_data['QST_max']) || $this->_req_data['QST_max'] > $max_max
+				) {
+					$set_column_values[ $fieldName ] = $max_max;
+				}
+			}
+
+
+			// only add a property to the array if it's not null (otherwise the model should just use the default value)
+			if (
+				! isset($set_column_values[ $fieldName ]) && isset($this->_req_data[ $fieldName ])
+			) {
+				$set_column_values[ $fieldName ] = $this->_req_data[ $fieldName ];
+			}
+		}
+		return $set_column_values;// validation fo this data to be performed by the model before insertion.
+	}
+
+
+	/**
+	 *_questions_overview_list_table
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _questions_overview_list_table()
+	{
+		$this->_search_btn_label = esc_html__('Questions', 'event_espresso');
+		$this->display_admin_list_table_page_with_sidebar();
+	}
+
+
+	/**
+	 * _edit_question
+	 *
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _edit_question()
+	{
+		$ID = isset($this->_req_data['QST_ID']) && ! empty($this->_req_data['QST_ID'])
+			? absint($this->_req_data['QST_ID'])
+			: false;
+
+		switch ($this->_req_action) {
+			case 'add_question':
+				$this->_admin_page_title = esc_html__('Add Question', 'event_espresso');
+				break;
+			case 'edit_question':
+				$this->_admin_page_title = esc_html__('Edit Question', 'event_espresso');
+				break;
+			default:
+				$this->_admin_page_title = ucwords(str_replace('_', ' ', $this->_req_action));
+		}
+
+		// add PRC_ID to title if editing
+		$this->_admin_page_title =
+			$ID
+				? $this->_admin_page_title . ' # ' . $ID
+				: $this->_admin_page_title;
+		if ($ID) {
+			$question                 = $this->_question_model->get_one_by_ID($ID);
+			$additional_hidden_fields = ['QST_ID' => ['type' => 'hidden', 'value' => $ID]];
+			$this->_set_add_edit_form_tags('update_question', $additional_hidden_fields);
+		} else {
+			$question = EE_Question::new_instance();
+			$question->set_order_to_latest();
+			$this->_set_add_edit_form_tags('insert_question');
+		}
+		if ($question->system_ID() === EEM_Attendee::system_question_phone) {
+			$question_types = array_intersect_key(
+				EEM_Question::instance()->allowed_question_types(),
+				array_flip(
+					[
+						EEM_Question::QST_type_text,
+						EEM_Question::QST_type_us_phone,
+					]
+				)
+			);
+		} else {
+			$question_types = $question->has_answers()
+				? $this->_question_model->question_types_in_same_category($question->type())
+				: $this->_question_model->allowed_question_types();
+		}
+		$this->_template_args['QST_ID']                     = $ID;
+		$this->_template_args['question']                   = $question;
+		$this->_template_args['question_types']             = $question_types;
+		$this->_template_args['max_max']                    =
+			EEM_Question::instance()->absolute_max_for_system_question(
+				$question->system_ID()
+			);
+		$this->_template_args['question_type_descriptions'] = $this->_get_question_type_descriptions();
+		$this->_set_publish_post_box_vars('id', $ID);
+		$this->_template_args['admin_page_content'] = EEH_Template::display_template(
+			REGISTRATION_FORM_TEMPLATE_PATH . 'questions_main_meta_box.template.php',
+			$this->_template_args,
+			true
+		);
+
+		// the details template wrapper
+		$this->display_admin_page_with_sidebar();
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_type_descriptions()
+	{
+		EE_Registry::instance()->load_helper('HTML');
+		$descriptions               = '';
+		$question_type_descriptions = EEM_Question::instance()->question_descriptions();
+		foreach ($question_type_descriptions as $type => $question_type_description) {
+			if ($type == 'HTML_TEXTAREA') {
+				$html                      = new EE_Simple_HTML_Validation_Strategy();
+				$question_type_description .= sprintf(
+					esc_html__('%1$s(allowed tags: %2$s)', 'event_espresso'),
+					'<br/>',
+					$html->get_list_of_allowed_tags()
+				);
+			}
+			$descriptions .= EEH_HTML::p(
+				$question_type_description,
+				'question_type_description-' . $type,
+				'question_type_description description',
+				'display:none;'
+			);
+		}
+		return $descriptions;
+	}
+
+
+	/**
+	 * @param bool|true $new_question
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _insert_or_update_question($new_question = true)
+	{
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		$set_column_values = $this->_set_column_values_for($this->_question_model);
+		if ($new_question) {
+			$question    = EE_Question::new_instance($set_column_values);
+			$action_desc = 'added';
+		} else {
+			$question = EEM_Question::instance()->get_one_by_ID(absint($this->_req_data['QST_ID']));
+			foreach ($set_column_values as $field => $new_value) {
+				$question->set($field, $new_value);
+			}
+			$action_desc = 'updated';
+		}
+		$success = $question->save();
+		$ID      = $question->ID();
+		if ($ID && $question->should_have_question_options()) {
+			// save the related options
+			// trash removed options, save old ones
+			// get list of all options
+			$options = $question->options();
+			if (! empty($options)) {
+				foreach ($options as $option_ID => $option) {
+					$option_req_index = $this->_get_option_req_data_index($option_ID);
+					if ($option_req_index !== false) {
+						$option->save($this->_req_data['question_options'][ $option_req_index ]);
+					} else {
+						// not found, remove it
+						$option->delete();
+					}
+				}
+			}
+			// save new related options
+			foreach ($this->_req_data['question_options'] as $index => $option_req_data) {
+				// skip $index that is from our sample
+				if ($index === 'xxcountxx') {
+					continue;
+				}
+				// note we allow saving blank options.
+				if (empty($option_req_data['QSO_ID'])) {
+					// no ID! save it!
+					$new_option = EE_Question_Option::new_instance(
+						[
+							'QSO_value' => $option_req_data['QSO_value'],
+							'QSO_desc'  => $option_req_data['QSO_desc'],
+							'QSO_order' => $option_req_data['QSO_order'],
+							'QST_ID'    => $question->ID(),
+						]
+					);
+					$new_option->save();
+				}
+			}
+		}
+		$query_args = ['action' => 'edit_question', 'QST_ID' => $ID];
+		if ($success !== 0) {
+			$msg = $new_question
+				? sprintf(
+					esc_html__('The %s has been created', 'event_espresso'),
+					$this->_question_model->item_name()
+				)
+				: sprintf(
+					esc_html__('The %s has been updated', 'event_espresso'),
+					$this->_question_model->item_name()
+				);
+			EE_Error::add_success($msg);
+		}
+
+		$this->_redirect_after_action(false, '', $action_desc, $query_args, true);
+	}
+
+
+	/**
+	 * Upon saving a question, there should be an array of 'question_options'. This array is index numerically, but not
+	 * by ID
+	 * (this is done because new question options don't have an ID, but we may want to add multiple simultaneously).
+	 * So, this function gets the index in that request data array called question_options. Returns FALSE if not found.
+	 *
+	 * @param int $ID of the question option to find
+	 * @return int index in question_options array if successful, FALSE if unsuccessful
+	 */
+	protected function _get_option_req_data_index($ID)
+	{
+		$req_data_for_question_options = $this->_req_data['question_options'];
+		foreach ($req_data_for_question_options as $num => $option_data) {
+			if (array_key_exists('QSO_ID', $option_data) && (int) $option_data['QSO_ID'] === $ID) {
+				return $num;
+			}
+		}
+		return false;
+	}
+
+
+
+
+	/***********/
+	/* QUERIES */
+	/**
+	 * For internal use in getting all the query parameters
+	 * (because it's pretty well the same between question, question groups,
+	 * and for both when searching for trashed and untrashed ones)
+	 *
+	 * @param EEM_Base $model either EEM_Question or EEM_Question_Group
+	 * @param int      $per_page
+	 * @param int      $current_page
+	 * @return array model query params, @see
+	 *               https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function get_query_params($model, $per_page = 10, $current_page = 10)
+	{
+		$query_params             = [];
+		$offset                   = ($current_page - 1) * $per_page;
+		$query_params['limit']    = [$offset, $per_page];
+		$order                    =
+			(isset($this->_req_data['order']) && ! empty($this->_req_data['order']))
+				? $this->_req_data['order']
+				: 'ASC';
+		$orderby_field            =
+			$model instanceof EEM_Question
+				? 'QST_ID'
+				: 'QSG_order';
+		$field_to_order_by        =
+			empty($this->_req_data['orderby'])
+				? $orderby_field
+				: $this->_req_data['orderby'];
+		$query_params['order_by'] = [$field_to_order_by => $order];
+		$search_string            =
+			array_key_exists('s', $this->_req_data)
+				? $this->_req_data['s']
+				: null;
+		if (! empty($search_string)) {
+			if ($model instanceof EEM_Question_Group) {
+				$query_params[0] = [
+					'OR' => [
+						'QSG_name' => ['LIKE', "%$search_string%"],
+						'QSG_desc' => ['LIKE', "%$search_string%"],
+					],
+				];
+			} else {
+				$query_params[0] = [
+					'QST_display_text' => ['LIKE', "%$search_string%"],
+				];
+			}
+		}
+
+		// capability checks (just leaving this commented out for reference because it illustrates some complicated query params that could be useful when fully implemented)
+		/*if ( $model instanceof EEM_Question_Group ) {
             if ( ! EE_Registry::instance()->CAP->current_user_can( 'edit_others_question_groups', 'espresso_registration_form_edit_question_group' ) ) {
                 $query_params[0] = array(
                     'AND' => array(
@@ -745,67 +745,67 @@ 
             }
         }/**/
 
-        return $query_params;
-    }
-
-
-    /**
-     * @param int        $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_questions($per_page = 10, $current_page = 1, $count = false)
-    {
-        $QST          = EEM_Question::instance();
-        $query_params = $this->get_query_params($QST, $per_page, $current_page);
-        if ($count) {
-            $where   =
-                isset($query_params[0])
-                    ? [$query_params[0]]
-                    : [];
-            $results = $QST->count($where);
-        } else {
-            $results = $QST->get_all($query_params);
-        }
-        return $results;
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     */
-    public function get_trashed_questions($per_page, $current_page = 1, $count = false)
-    {
-        $query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
-        $where        =
-            isset($query_params[0])
-                ? [$query_params[0]]
-                : [];
-        return $count
-            ? EEM_Question::instance()->count_deleted($where)
-            : EEM_Question::instance()->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * @param            $per_page
-     * @param int        $current_page
-     * @param bool|false $count
-     * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_question_groups($per_page, $current_page = 1, $count = false)
-    {
-        $questionGroupModel = EEM_Question_Group::instance();
-        // note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
-        return $questionGroupModel->get_all(
-            $this->get_query_params($questionGroupModel, $per_page, $current_page)
-        );
-    }
+		return $query_params;
+	}
+
+
+	/**
+	 * @param int        $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_questions($per_page = 10, $current_page = 1, $count = false)
+	{
+		$QST          = EEM_Question::instance();
+		$query_params = $this->get_query_params($QST, $per_page, $current_page);
+		if ($count) {
+			$where   =
+				isset($query_params[0])
+					? [$query_params[0]]
+					: [];
+			$results = $QST->count($where);
+		} else {
+			$results = $QST->get_all($query_params);
+		}
+		return $results;
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 */
+	public function get_trashed_questions($per_page, $current_page = 1, $count = false)
+	{
+		$query_params = $this->get_query_params(EEM_Question::instance(), $per_page, $current_page);
+		$where        =
+			isset($query_params[0])
+				? [$query_params[0]]
+				: [];
+		return $count
+			? EEM_Question::instance()->count_deleted($where)
+			: EEM_Question::instance()->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * @param            $per_page
+	 * @param int        $current_page
+	 * @param bool|false $count
+	 * @return EE_Base_Class[]|EE_Question_Group[]|EE_Soft_Delete_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_question_groups($per_page, $current_page = 1, $count = false)
+	{
+		$questionGroupModel = EEM_Question_Group::instance();
+		// note: this a subclass of EEM_Soft_Delete_Base, so this is actually only getting non-trashed items
+		return $questionGroupModel->get_all(
+			$this->get_query_params($questionGroupModel, $per_page, $current_page)
+		);
+	}
 }

caffeinated/core/libraries/shortcodes/EE_Question_List_Shortcodes.lib.php

Spacing +4 added lines, -4 removed lines

@@ -94,16 +94,16 @@
             ? $this->_extra_data['template']['question_list']
             : $template;
         $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+        $answers          = ! empty($this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs'])
+            ? $this->_extra_data['data']->registrations[$reg_obj->ID()]['ans_objs']
             : [];
         $questions        = ! empty($this->_extra_data['data']->questions)
             ? $this->_extra_data['data']->questions
             : [];
         foreach ($answers as $answer) {
             // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
+            $question = isset($questions[$answer->ID()])
+                ? $questions[$answer->ID()]
                 : null;
             $question = ! $question instanceof EE_Question
                 ? $answer->question()

Indentation +95 added lines, -95 removed lines

@@ -15,109 +15,109 @@
  */
 class EE_Question_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
 
 
-    protected function _init_props()
-    {
-        $this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
-        $this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
-        $this->_shortcodes = [
-            '[QUESTION_LIST]' => esc_html__(
-                'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
-                'event_espresso'
-            ),
-        ];
-    }
+	protected function _init_props()
+	{
+		$this->label       = esc_html__('Questions and Answers Shortcodes', 'event_espresso');
+		$this->description = esc_html__('All shortcodes related to custom questions and answers', 'event_espresso');
+		$this->_shortcodes = [
+			'[QUESTION_LIST]' => esc_html__(
+				'This is used to indicate where you want the list of questions and answers to show for the registrant.  You place this within the "[attendee_list]" field.',
+				'event_espresso'
+			),
+		];
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[QUESTION_LIST]':
-                return $this->_get_question_list();
-        }
-        return '';
-    }
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[QUESTION_LIST]':
+				return $this->_get_question_list();
+		}
+		return '';
+	}
 
 
-    /**
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_question_list()
-    {
-        $this->_validate_list_requirements();
+	/**
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_question_list()
+	{
+		$this->_validate_list_requirements();
 
-        // for when [QUESTION_LIST] is used in the [attendee_list] field.
-        if ($this->_data['data'] instanceof EE_Registration) {
-            return $this->_get_question_answer_list_for_attendee();
-        }
-        // for when [QUESTION_LIST] is used in the main content field.
-        if (
-            $this->_data['data'] instanceof EE_Messages_Addressee
-            && $this->_data['data']->reg_obj instanceof EE_Registration
-        ) {
-            return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
-        }
-        return '';
-    }
+		// for when [QUESTION_LIST] is used in the [attendee_list] field.
+		if ($this->_data['data'] instanceof EE_Registration) {
+			return $this->_get_question_answer_list_for_attendee();
+		}
+		// for when [QUESTION_LIST] is used in the main content field.
+		if (
+			$this->_data['data'] instanceof EE_Messages_Addressee
+			&& $this->_data['data']->reg_obj instanceof EE_Registration
+		) {
+			return $this->_get_question_answer_list_for_attendee($this->_data['data']->reg_obj);
+		}
+		return '';
+	}
 
 
-    /**
-     * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
-     * answers for that attendee since that is what we really need (we can derive the questions from the answers);
-     *
-     * @param null $reg_obj
-     * @return string parsed template.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _get_question_answer_list_for_attendee($reg_obj = null)
-    {
-        $valid_shortcodes = ['question'];
-        $reg_obj          = $reg_obj instanceof EE_Registration
-            ? $reg_obj
-            : $this->_data['data'];
-        $template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
-            ? $this->_data['template']['question_list']
-            : '';
-        $template         = empty($template) && isset($this->_extra_data['template']['question_list'])
-            ? $this->_extra_data['template']['question_list']
-            : $template;
-        $ans_result       = '';
-        $answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
-            ? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
-            : [];
-        $questions        = ! empty($this->_extra_data['data']->questions)
-            ? $this->_extra_data['data']->questions
-            : [];
-        foreach ($answers as $answer) {
-            // first see if the question is in our $questions array.  If not then try to get from answer object
-            $question = isset($questions[ $answer->ID() ])
-                ? $questions[ $answer->ID() ]
-                : null;
-            $question = ! $question instanceof EE_Question
-                ? $answer->question()
-                : $question;
-            if ($question instanceof EE_Question and $question->admin_only()) {
-                continue;
-            }
-            $ans_result .= $this->_shortcode_helper->parse_question_list_template(
-                $template,
-                $answer,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
+	/**
+	 * Note when we parse the "[question_list]" shortcode for attendees we're actually going to retrieve the list of
+	 * answers for that attendee since that is what we really need (we can derive the questions from the answers);
+	 *
+	 * @param null $reg_obj
+	 * @return string parsed template.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _get_question_answer_list_for_attendee($reg_obj = null)
+	{
+		$valid_shortcodes = ['question'];
+		$reg_obj          = $reg_obj instanceof EE_Registration
+			? $reg_obj
+			: $this->_data['data'];
+		$template         = is_array($this->_data['template']) && isset($this->_data['template']['question_list'])
+			? $this->_data['template']['question_list']
+			: '';
+		$template         = empty($template) && isset($this->_extra_data['template']['question_list'])
+			? $this->_extra_data['template']['question_list']
+			: $template;
+		$ans_result       = '';
+		$answers          = ! empty($this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs'])
+			? $this->_extra_data['data']->registrations[ $reg_obj->ID() ]['ans_objs']
+			: [];
+		$questions        = ! empty($this->_extra_data['data']->questions)
+			? $this->_extra_data['data']->questions
+			: [];
+		foreach ($answers as $answer) {
+			// first see if the question is in our $questions array.  If not then try to get from answer object
+			$question = isset($questions[ $answer->ID() ])
+				? $questions[ $answer->ID() ]
+				: null;
+			$question = ! $question instanceof EE_Question
+				? $answer->question()
+				: $question;
+			if ($question instanceof EE_Question and $question->admin_only()) {
+				continue;
+			}
+			$ans_result .= $this->_shortcode_helper->parse_question_list_template(
+				$template,
+				$answer,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
 
-        return $ans_result;
-    }
+		return $ans_result;
+	}
 }

caffeinated/payment_methods/Paypal_Pro/help_tabs/payment_methods_overview_paypalpro.help_tab.php

Indentation +37 added lines, -37 removed lines

@@ -4,10 +4,10 @@ 
 </p>
 <p>
     <?php printf(
-        esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
-        "<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    ); ?>
+		esc_html__('See %1$shere%2$s for list of currencies supported by Paypal Pro.', 'event_espresso'),
+		"<a href='https://www.paypal.com/multicurrency' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	); ?>
 </p>
 <p><strong><?php esc_html_e('PayPal Pro Settings', 'event_espresso'); ?></strong></p>
 <ul>
@@ -18,48 +18,48 @@ 
     <li>
         <strong><?php esc_html_e('PayPal API Username', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Username for PayPal. Learn how to find your %1$sAPI Username%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Password', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Password for PayPal. Learn how to find your %1$sAPI Password%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('PayPal API Signature', 'event_espresso'); ?></strong><br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Signature for PayPal. Learn how to find your %1$sAPI Signature%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://www.paypal.com/us/cgi-bin/webscr?cmd=xpt/cps/merchant/wppro/WPProIntegrationSteps-outside#SectionB" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Country Currency', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Select the currency for your country. Payments will be accepted in this currency.',
-            'event_espresso'
-        ); ?>
+			'Select the currency for your country. Payments will be accepted in this currency.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Accepted Card Types', 'event_espresso'); ?></strong><br/>
@@ -68,9 +68,9 @@ 
     <li>
         <strong><?php esc_html_e('Use the Debugging Feature and the PayPal Sandbox', 'event_espresso'); ?></strong><br/>
         <?php esc_html_e(
-            'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the payment gateway by submitting a test transaction. If this option is enabled, be sure to enter your PayPal sandbox credentials in the fields above. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong><br/>

caffeinated/payment_methods/Aim/help_tabs/payment_methods_overview_aim.help_tab.php

Indentation +54 added lines, -54 removed lines

@@ -6,15 +6,15 @@ 
 </p>
 <p>
     <?php
-    printf(
-        esc_html__(
-            'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
-            'event_espresso'
-        ),
-        "<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
-        "</a>"
-    );
-    ?>
+	printf(
+		esc_html__(
+			'See %1$shere%2$s for list of currencies supported by Authorize.net AIM.',
+			'event_espresso'
+		),
+		"<a href='https://support.authorize.net/s/article/Which-Currencies-Does-Authorize-Net-Support/' target='_blank' rel='noopener noreferrer'>",
+		"</a>"
+	);
+	?>
 </p>
 <p>
     <strong><?php esc_html_e('Authorize.net AIM Settings', 'event_espresso'); ?></strong>
@@ -24,70 +24,70 @@ 
         <strong><?php esc_html_e('Authorize.net API Login ID', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your API Login ID for Authorize.net. Learn how to find your %1$sAPI Login%2$s ID.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong><?php esc_html_e('Authorize.net Transaction Key', 'event_espresso'); ?></strong>
         <br/>
         <?php
-        printf(
-            esc_html__(
-                'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
-                'event_espresso'
-            ),
-            '<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
-            '</a>'
-        );
-        ?>
+		printf(
+			esc_html__(
+				'Enter your Transaction Key for Authorize.net. Learn how to find your %1$sTransaction Key%2$s.',
+				'event_espresso'
+			),
+			'<a href="https://support.authorize.net/authkb/index?page=content&id=A405" target="_blank" rel="noopener noreferrer">',
+			'</a>'
+		);
+		?>
     </li>
     <li>
         <strong>
             <?php esc_html_e(
-                'Is this an account on the Authorize.net development server?',
-                'event_espresso'
-            ); ?>
+				'Is this an account on the Authorize.net development server?',
+				'event_espresso'
+			); ?>
         </strong>
         <br/>
         <?php esc_html_e(
-            'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
-            'event_espresso'
-        ); ?>
+			'Specify whether this is a live/production account or a test account on the Authorize.net development server.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Do you want to submit a test transaction?', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
-            'event_espresso'
-        ); ?>
+			'Specify if you want to test the Authorize.net AIM payment gateway by submitting a test transaction. Be sure to turn this setting off when you are done testing.',
+			'event_espresso'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Excluded and Required Payment Form Fields', 'event_espresso'); ?></strong>
         <br/>
         <?php esc_html_e(
-            'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
-            'event_espresso'
-        ); ?>
+			'By logging into Authorize.net, you can change which payment fields are required by Authorize.net when processing payments. These settings affect both the Advanced Integration Method (AIM, this) and the Simple Integration Method (SIM, different). The payment method settings "Excluded Payment Form Fields" and "Required Payment Form Fields" allow you to change the billing form in Event Espresso to reflect your payment form settings in Authorize.net.',
+			'event_espresso'
+		); ?>
         <br>
         <?php printf(
-            esc_html__(
-                'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
-                'event_espresso'
-            ),
-            '<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
-            '</a>',
-            '<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
-            '<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
-        ); ?>
+			esc_html__(
+				'To change your payment form settings in Authorize.net, %1$slog in to authorize.net%2$s, go to %3$sAccount then Payment Form%2$s, then %4$sForm Fields%2$s. It will look similar to %5$sthis%2$s. If you make a field required in Authorize.net, you should also make it required in Event Espresso. If it isn\'t required in Authorize.net, and you want to simplify the billing form in Event Espresso, you can exclude it from the Event Espresso Form too.',
+				'event_espresso'
+			),
+			'<a href="http://authorize.net" target="_blank" rel="noopener noreferrer">',
+			'</a>',
+			'<a href="https://monosnap.com/file/nebVteOkEXcdDIos88SojStWOifP23" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/file/WyxGJtev87TcDmdGBEZ2oi1xaBIQAm" target="_blank" rel="noopener noreferrer">',
+			'<a href="https://monosnap.com/image/DbCJNfEesWXeSNUs1wLIpGYODFw52m" target="_blank" rel="noopener noreferrer">'
+		); ?>
     </li>
     <li>
         <strong><?php esc_html_e('Button Image URL', 'event_espresso'); ?></strong>
@@ -97,10 +97,10 @@ 
     <li>
         <strong><?php esc_html_e('Note About Special Characters', 'event_espresso'); ?></strong>
         <?php
-        esc_html_e(
-            'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
-            'event_espresso'
-        );
-        ?>
+		esc_html_e(
+			'If your event name, ticket name or ticket description contain special characters (eg emojis, foreign language characters, or curly quotes) they will be removed when sent to Authorize.net. This is because Authorize.net doesn\'t support them.',
+			'event_espresso'
+		);
+		?>
     </li>
 </ul>
\ No newline at end of file

caffeinated/brewing_regular.php

Spacing +31 added lines, -31 removed lines

@@ -12,10 +12,10 @@ 
 use EventEspresso\core\services\database\TableAnalysis;
 
 // defined some new constants related to caffeinated folder
-define('EE_CAF_URL', EE_PLUGIN_DIR_URL . 'caffeinated/');
-define('EE_CAF_CORE', EE_CAFF_PATH . 'core/');
-define('EE_CAF_LIBRARIES', EE_CAF_CORE . 'libraries/');
-define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH . 'payment_methods/');
+define('EE_CAF_URL', EE_PLUGIN_DIR_URL.'caffeinated/');
+define('EE_CAF_CORE', EE_CAFF_PATH.'core/');
+define('EE_CAF_LIBRARIES', EE_CAF_CORE.'libraries/');
+define('EE_CAF_PAYMENT_METHODS', EE_CAFF_PATH.'payment_methods/');
 
 
 /**
@@ -65,11 +65,11 @@ 
         add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
         add_filter(
             'AHEE__EE_System__load_core_configuration__complete',
-            function () {
+            function() {
                 EE_Register_Payment_Method::register(
                     'caffeinated_payment_methods',
                     [
-                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
+                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS.'*', GLOB_ONLYDIR),
                     ]
                 );
             }
@@ -124,7 +124,7 @@ 
      */
     public function caf_helper_paths($paths)
     {
-        $paths[] = EE_CAF_CORE . 'helpers/';
+        $paths[] = EE_CAF_CORE.'helpers/';
         return $paths;
     }
 
@@ -145,11 +145,11 @@ 
         global $wpdb;
         // use same method of getting creator id as the version introducing the change
         $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table   = $wpdb->prefix . "esp_price_type";
-        $price_table        = $wpdb->prefix . "esp_price";
+        $price_type_table   = $wpdb->prefix."esp_price_type";
+        $price_table        = $wpdb->prefix."esp_price";
         if ($this->_get_table_analysis()->tableExists($price_type_table)) {
             $SQL                  =
-                'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
+                'SELECT COUNT(PRT_ID) FROM '.$price_type_table.' WHERE PBT_ID=4'; // include trashed price types
             $tax_price_type_count = $wpdb->get_var($SQL);
             if ($tax_price_type_count <= 1) {
                 $wpdb->insert(
@@ -163,11 +163,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ],
                     [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
+                        '%s', // PRT_name
+                        '%d', // PBT_id
+                        '%d', // PRT_is_percent
+                        '%d', // PRT_order
+                        '%d', // PRT_deleted
                         '%d', // PRT_wp_user
                     ]
                 );
@@ -183,11 +183,11 @@ 
                         'PRT_wp_user'    => $default_creator_id,
                     ],
                     [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
+                        '%s', // PRT_name
+                        '%d', // PBT_id
+                        '%d', // PRT_is_percent
+                        '%d', // PRT_order
+                        '%d', // PRT_deleted
                         '%d' // PRT_wp_user
                     ]
                 );
@@ -207,15 +207,15 @@ 
                             'PRC_wp_user'    => $default_creator_id,
                         ],
                         [
-                            '%d',// PRT_id
-                            '%f',// PRC_amount
-                            '%s',// PRC_name
-                            '%s',// PRC_desc
-                            '%d',// PRC_is_default
-                            '%d',// PRC_overrides
-                            '%d',// PRC_deleted
-                            '%d',// PRC_order
-                            '%d',// PRC_parent
+                            '%d', // PRT_id
+                            '%f', // PRC_amount
+                            '%s', // PRC_name
+                            '%s', // PRC_desc
+                            '%d', // PRC_is_default
+                            '%d', // PRC_overrides
+                            '%d', // PRC_deleted
+                            '%d', // PRC_order
+                            '%d', // PRC_parent
                             '%d' // PRC_wp_user
                         ]
                     );
@@ -234,8 +234,8 @@ 
      */
     public function caffeinated_modules_to_register($modules_to_register = [])
     {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
+        if (is_readable(EE_CAFF_PATH.'modules')) {
+            $caffeinated_modules_to_register = glob(EE_CAFF_PATH.'modules/*', GLOB_ONLYDIR);
             if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
                 $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
             }

Indentation +315 added lines, -315 removed lines

@@ -27,323 +27,323 @@
  */
 class EE_Brewing_Regular extends EE_BASE implements InterminableInterface
 {
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    protected $_table_analysis;
-
-
-    /**
-     * EE_Brewing_Regular constructor.
-     *
-     * @param TableAnalysis $table_analysis
-     */
-    public function __construct(TableAnalysis $table_analysis)
-    {
-        $this->_table_analysis = $table_analysis;
-        if (defined('EE_CAFF_PATH')) {
-            $this->setInitializationHooks();
-            $this->setApiRegistrationHooks();
-            $this->setSwitchHooks();
-            $this->setDefaultFilterHooks();
-            // caffeinated constructed
-            do_action('AHEE__EE_Brewing_Regular__construct__complete');
-        }
-    }
-
-
-    /**
-     * Various hooks used for extending features via registration of modules or extensions.
-     */
-    private function setApiRegistrationHooks()
-    {
-        add_filter(
-            'FHEE__EE_Config__register_modules__modules_to_register',
-            [$this, 'caffeinated_modules_to_register']
-        );
-        add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
-        add_filter(
-            'AHEE__EE_System__load_core_configuration__complete',
-            function () {
-                EE_Register_Payment_Method::register(
-                    'caffeinated_payment_methods',
-                    [
-                        'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
-                    ]
-                );
-            }
-        );
-    }
-
-
-    /**
-     * Various hooks used for modifying initialization or activation processes.
-     */
-    private function setInitializationHooks()
-    {
-        // activation
-        add_action('AHEE__EEH_Activation__initialize_db_content', [$this, 'initialize_caf_db_content']);
-        // load caff init
-        add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'caffeinated_init']);
-        // load caff scripts
-        add_action('wp_enqueue_scripts', [$this, 'enqueue_caffeinated_scripts'], 10);
-    }
-
-
-    /**
-     * Various hooks used for switch (on/off) type filters.
-     */
-    private function setSwitchHooks()
-    {
-        // remove the "powered by" credit link from receipts and invoices
-        add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
-        // seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
-        add_filter('FHEE__ee_show_affiliate_links', '__return_false');
-    }
-
-
-    /**
-     * Various filters for affecting default configuration values in the caffeinated
-     * context.
-     */
-    private function setDefaultFilterHooks()
-    {
-        add_filter(
-            'FHEE__EE_Admin_Config__show_reg_footer__default',
-            '__return_true'
-        );
-    }
-
-
-    /**
-     * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
-     *
-     * @param array $paths original helper paths array
-     * @return array             new array of paths
-     */
-    public function caf_helper_paths($paths)
-    {
-        $paths[] = EE_CAF_CORE . 'helpers/';
-        return $paths;
-    }
-
-
-    /**
-     * Upon brand-new activation, if this is a new activation of CAF, we want to add
-     * some global prices that will show off EE4's capabilities. However, if they're upgrading
-     * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
-     * This action should only be called when EE 4.x.0.P is initially activated.
-     * Right now the only CAF content are these global prices. If there's more in the future, then
-     * we should probably create a caf file to contain it all instead just a function like this.
-     * Right now, we ASSUME the only price types in the system are default ones
-     *
-     * @global wpdb $wpdb
-     */
-    public function initialize_caf_db_content()
-    {
-        global $wpdb;
-        // use same method of getting creator id as the version introducing the change
-        $default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
-        $price_type_table   = $wpdb->prefix . "esp_price_type";
-        $price_table        = $wpdb->prefix . "esp_price";
-        if ($this->_get_table_analysis()->tableExists($price_type_table)) {
-            $SQL                  =
-                'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
-            $tax_price_type_count = $wpdb->get_var($SQL);
-            if ($tax_price_type_count <= 1) {
-                $wpdb->insert(
-                    $price_type_table,
-                    [
-                        'PRT_name'       => esc_html__("Regional Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 60,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ],
-                    [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
-                        '%d', // PRT_wp_user
-                    ]
-                );
-                // federal tax
-                $result = $wpdb->insert(
-                    $price_type_table,
-                    [
-                        'PRT_name'       => esc_html__("Federal Tax", "event_espresso"),
-                        'PBT_ID'         => 4,
-                        'PRT_is_percent' => true,
-                        'PRT_order'      => 70,
-                        'PRT_deleted'    => false,
-                        'PRT_wp_user'    => $default_creator_id,
-                    ],
-                    [
-                        '%s',// PRT_name
-                        '%d',// PBT_id
-                        '%d',// PRT_is_percent
-                        '%d',// PRT_order
-                        '%d',// PRT_deleted
-                        '%d' // PRT_wp_user
-                    ]
-                );
-                if ($result) {
-                    $wpdb->insert(
-                        $price_table,
-                        [
-                            'PRT_ID'         => $wpdb->insert_id,
-                            'PRC_amount'     => 15.00,
-                            'PRC_name'       => esc_html__("Sales Tax", "event_espresso"),
-                            'PRC_desc'       => '',
-                            'PRC_is_default' => true,
-                            'PRC_overrides'  => null,
-                            'PRC_deleted'    => false,
-                            'PRC_order'      => 50,
-                            'PRC_parent'     => null,
-                            'PRC_wp_user'    => $default_creator_id,
-                        ],
-                        [
-                            '%d',// PRT_id
-                            '%f',// PRC_amount
-                            '%s',// PRC_name
-                            '%s',// PRC_desc
-                            '%d',// PRC_is_default
-                            '%d',// PRC_overrides
-                            '%d',// PRC_deleted
-                            '%d',// PRC_order
-                            '%d',// PRC_parent
-                            '%d' // PRC_wp_user
-                        ]
-                    );
-                }
-            }
-        }
-    }
-
-
-    /**
-     *    caffeinated_modules_to_register
-     *
-     * @access public
-     * @param array $modules_to_register
-     * @return array
-     */
-    public function caffeinated_modules_to_register($modules_to_register = [])
-    {
-        if (is_readable(EE_CAFF_PATH . 'modules')) {
-            $caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
-            if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
-                $modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
-            }
-        }
-        return $modules_to_register;
-    }
-
-
-    /**
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function caffeinated_init()
-    {
-        // Custom Post Type hooks
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
-            [$this, 'filter_taxonomies']
-        );
-        add_filter(
-            'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
-            [$this, 'filter_cpts']
-        );
-        add_filter(
-            'FHEE__EE_Admin__get_extra_nav_menu_pages_items',
-            [$this, 'nav_metabox_items']
-        );
-        EE_Registry::instance()->load_file(
-            EE_CAFF_PATH,
-            'EE_Caf_Messages',
-            'class',
-            [],
-            false
-        );
-        // caffeinated_init__complete hook
-        do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
-    }
-
-
-    public function enqueue_caffeinated_scripts()
-    {
-        // sound of crickets...
-    }
-
-
-    /**
-     * callbacks below here
-     *
-     * @param array $taxonomy_array
-     * @return array
-     */
-    public function filter_taxonomies(array $taxonomy_array)
-    {
-        $taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
-        return $taxonomy_array;
-    }
-
-
-    /**
-     * @param array $cpt_array
-     * @return mixed
-     */
-    public function filter_cpts(array $cpt_array)
-    {
-        $cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
-        return $cpt_array;
-    }
-
-
-    /**
-     * @param array $menuitems
-     * @return array
-     */
-    public function nav_metabox_items(array $menuitems)
-    {
-        $menuitems[] = [
-            'title'       => esc_html__('Venue List', 'event_espresso'),
-            'url'         => get_post_type_archive_link('espresso_venues'),
-            'description' => esc_html__('Archive page for all venues.', 'event_espresso'),
-        ];
-        return $menuitems;
-    }
-
-
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function _get_table_analysis()
-    {
-        if ($this->_table_analysis instanceof TableAnalysis) {
-            return $this->_table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	protected $_table_analysis;
+
+
+	/**
+	 * EE_Brewing_Regular constructor.
+	 *
+	 * @param TableAnalysis $table_analysis
+	 */
+	public function __construct(TableAnalysis $table_analysis)
+	{
+		$this->_table_analysis = $table_analysis;
+		if (defined('EE_CAFF_PATH')) {
+			$this->setInitializationHooks();
+			$this->setApiRegistrationHooks();
+			$this->setSwitchHooks();
+			$this->setDefaultFilterHooks();
+			// caffeinated constructed
+			do_action('AHEE__EE_Brewing_Regular__construct__complete');
+		}
+	}
+
+
+	/**
+	 * Various hooks used for extending features via registration of modules or extensions.
+	 */
+	private function setApiRegistrationHooks()
+	{
+		add_filter(
+			'FHEE__EE_Config__register_modules__modules_to_register',
+			[$this, 'caffeinated_modules_to_register']
+		);
+		add_filter('FHEE__EE_Registry__load_helper__helper_paths', [$this, 'caf_helper_paths'], 10);
+		add_filter(
+			'AHEE__EE_System__load_core_configuration__complete',
+			function () {
+				EE_Register_Payment_Method::register(
+					'caffeinated_payment_methods',
+					[
+						'payment_method_paths' => glob(EE_CAF_PAYMENT_METHODS . '*', GLOB_ONLYDIR),
+					]
+				);
+			}
+		);
+	}
+
+
+	/**
+	 * Various hooks used for modifying initialization or activation processes.
+	 */
+	private function setInitializationHooks()
+	{
+		// activation
+		add_action('AHEE__EEH_Activation__initialize_db_content', [$this, 'initialize_caf_db_content']);
+		// load caff init
+		add_action('AHEE__EE_System__set_hooks_for_core', [$this, 'caffeinated_init']);
+		// load caff scripts
+		add_action('wp_enqueue_scripts', [$this, 'enqueue_caffeinated_scripts'], 10);
+	}
+
+
+	/**
+	 * Various hooks used for switch (on/off) type filters.
+	 */
+	private function setSwitchHooks()
+	{
+		// remove the "powered by" credit link from receipts and invoices
+		add_filter('FHEE_EE_Html_messenger__add_powered_by_credit_link_to_receipt_and_invoice', '__return_false');
+		// seeing how this is caf, which isn't put on WordPress.org, we can have affiliate links without a disclaimer
+		add_filter('FHEE__ee_show_affiliate_links', '__return_false');
+	}
+
+
+	/**
+	 * Various filters for affecting default configuration values in the caffeinated
+	 * context.
+	 */
+	private function setDefaultFilterHooks()
+	{
+		add_filter(
+			'FHEE__EE_Admin_Config__show_reg_footer__default',
+			'__return_true'
+		);
+	}
+
+
+	/**
+	 * callback for the FHEE__EE_Registry__load_helper__helper_paths filter to add the caffeinated paths
+	 *
+	 * @param array $paths original helper paths array
+	 * @return array             new array of paths
+	 */
+	public function caf_helper_paths($paths)
+	{
+		$paths[] = EE_CAF_CORE . 'helpers/';
+		return $paths;
+	}
+
+
+	/**
+	 * Upon brand-new activation, if this is a new activation of CAF, we want to add
+	 * some global prices that will show off EE4's capabilities. However, if they're upgrading
+	 * from 3.1, or simply EE4.x decaf, we assume they don't want us to suddenly introduce these extra prices.
+	 * This action should only be called when EE 4.x.0.P is initially activated.
+	 * Right now the only CAF content are these global prices. If there's more in the future, then
+	 * we should probably create a caf file to contain it all instead just a function like this.
+	 * Right now, we ASSUME the only price types in the system are default ones
+	 *
+	 * @global wpdb $wpdb
+	 */
+	public function initialize_caf_db_content()
+	{
+		global $wpdb;
+		// use same method of getting creator id as the version introducing the change
+		$default_creator_id = apply_filters('FHEE__EE_DMS_Core_4_5_0__get_default_creator_id', get_current_user_id());
+		$price_type_table   = $wpdb->prefix . "esp_price_type";
+		$price_table        = $wpdb->prefix . "esp_price";
+		if ($this->_get_table_analysis()->tableExists($price_type_table)) {
+			$SQL                  =
+				'SELECT COUNT(PRT_ID) FROM ' . $price_type_table . ' WHERE PBT_ID=4';// include trashed price types
+			$tax_price_type_count = $wpdb->get_var($SQL);
+			if ($tax_price_type_count <= 1) {
+				$wpdb->insert(
+					$price_type_table,
+					[
+						'PRT_name'       => esc_html__("Regional Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 60,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					],
+					[
+						'%s',// PRT_name
+						'%d',// PBT_id
+						'%d',// PRT_is_percent
+						'%d',// PRT_order
+						'%d',// PRT_deleted
+						'%d', // PRT_wp_user
+					]
+				);
+				// federal tax
+				$result = $wpdb->insert(
+					$price_type_table,
+					[
+						'PRT_name'       => esc_html__("Federal Tax", "event_espresso"),
+						'PBT_ID'         => 4,
+						'PRT_is_percent' => true,
+						'PRT_order'      => 70,
+						'PRT_deleted'    => false,
+						'PRT_wp_user'    => $default_creator_id,
+					],
+					[
+						'%s',// PRT_name
+						'%d',// PBT_id
+						'%d',// PRT_is_percent
+						'%d',// PRT_order
+						'%d',// PRT_deleted
+						'%d' // PRT_wp_user
+					]
+				);
+				if ($result) {
+					$wpdb->insert(
+						$price_table,
+						[
+							'PRT_ID'         => $wpdb->insert_id,
+							'PRC_amount'     => 15.00,
+							'PRC_name'       => esc_html__("Sales Tax", "event_espresso"),
+							'PRC_desc'       => '',
+							'PRC_is_default' => true,
+							'PRC_overrides'  => null,
+							'PRC_deleted'    => false,
+							'PRC_order'      => 50,
+							'PRC_parent'     => null,
+							'PRC_wp_user'    => $default_creator_id,
+						],
+						[
+							'%d',// PRT_id
+							'%f',// PRC_amount
+							'%s',// PRC_name
+							'%s',// PRC_desc
+							'%d',// PRC_is_default
+							'%d',// PRC_overrides
+							'%d',// PRC_deleted
+							'%d',// PRC_order
+							'%d',// PRC_parent
+							'%d' // PRC_wp_user
+						]
+					);
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *    caffeinated_modules_to_register
+	 *
+	 * @access public
+	 * @param array $modules_to_register
+	 * @return array
+	 */
+	public function caffeinated_modules_to_register($modules_to_register = [])
+	{
+		if (is_readable(EE_CAFF_PATH . 'modules')) {
+			$caffeinated_modules_to_register = glob(EE_CAFF_PATH . 'modules/*', GLOB_ONLYDIR);
+			if (is_array($caffeinated_modules_to_register) && ! empty($caffeinated_modules_to_register)) {
+				$modules_to_register = array_merge($modules_to_register, $caffeinated_modules_to_register);
+			}
+		}
+		return $modules_to_register;
+	}
+
+
+	/**
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function caffeinated_init()
+	{
+		// Custom Post Type hooks
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_TaxonomyDefinitions__getTaxonomies',
+			[$this, 'filter_taxonomies']
+		);
+		add_filter(
+			'FHEE__EventEspresso_core_domain_entities_custom_post_types_CustomPostTypeDefinitions__getCustomPostTypes',
+			[$this, 'filter_cpts']
+		);
+		add_filter(
+			'FHEE__EE_Admin__get_extra_nav_menu_pages_items',
+			[$this, 'nav_metabox_items']
+		);
+		EE_Registry::instance()->load_file(
+			EE_CAFF_PATH,
+			'EE_Caf_Messages',
+			'class',
+			[],
+			false
+		);
+		// caffeinated_init__complete hook
+		do_action('AHEE__EE_Brewing_Regular__caffeinated_init__complete');
+	}
+
+
+	public function enqueue_caffeinated_scripts()
+	{
+		// sound of crickets...
+	}
+
+
+	/**
+	 * callbacks below here
+	 *
+	 * @param array $taxonomy_array
+	 * @return array
+	 */
+	public function filter_taxonomies(array $taxonomy_array)
+	{
+		$taxonomy_array['espresso_venue_categories']['args']['show_in_nav_menus'] = true;
+		return $taxonomy_array;
+	}
+
+
+	/**
+	 * @param array $cpt_array
+	 * @return mixed
+	 */
+	public function filter_cpts(array $cpt_array)
+	{
+		$cpt_array['espresso_venues']['args']['show_in_nav_menus'] = true;
+		return $cpt_array;
+	}
+
+
+	/**
+	 * @param array $menuitems
+	 * @return array
+	 */
+	public function nav_metabox_items(array $menuitems)
+	{
+		$menuitems[] = [
+			'title'       => esc_html__('Venue List', 'event_espresso'),
+			'url'         => get_post_type_archive_link('espresso_venues'),
+			'description' => esc_html__('Archive page for all venues.', 'event_espresso'),
+		];
+		return $menuitems;
+	}
+
+
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function _get_table_analysis()
+	{
+		if ($this->_table_analysis instanceof TableAnalysis) {
+			return $this->_table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					esc_html__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 }
 
 
 $brewing = new EE_Brewing_Regular(
-    EE_Registry::instance()->create('TableAnalysis', [], true)
+	EE_Registry::instance()->create('TableAnalysis', [], true)
 );

core/libraries/messages/validators/EE_Messages_Validator.core.php

Spacing +53 added lines, -53 removed lines

@@ -156,9 +156,9 @@ 
         // load messenger
         $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
         $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
+        $messenger = 'EE_'.$messenger.'_messenger';
 
-        if (! class_exists($messenger)) {
+        if ( ! class_exists($messenger)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
@@ -172,9 +172,9 @@ 
         // load message type
         $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
         $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
+        $message_type = 'EE_'.$message_type.'_message_type';
 
-        if (! class_exists($message_type)) {
+        if ( ! class_exists($message_type)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
@@ -206,7 +206,7 @@ 
 
         // we only want the valid shortcodes for the given context!
         $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
+        $mt_codes = $mt_codes[$context];
 
         // in this first loop we're just getting all shortcode group indexes from the msgr_validator
         // into a single array (so we can get the appropriate shortcode objects for the groups)
@@ -217,7 +217,7 @@ 
             if (empty($config) || ! isset($config['shortcodes'])) {
                 continue;
             }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+            $groups_per_field[$field] = array_intersect($config['shortcodes'], $mt_codes);
             $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
         }
 
@@ -230,11 +230,11 @@ 
         foreach ($shortcode_groups as $group) {
             $ref       = ucwords(str_replace('_', ' ', $group));
             $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
+            $classname = 'EE_'.$ref.'_Shortcodes';
             if (class_exists($classname)) {
                 $a                         = new ReflectionClass($classname);
                 $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
+                $codes_from_objs[$group] = $obj->get_shortcodes();
             }
         }
 
@@ -242,7 +242,7 @@ 
         // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
         $final_mt_codes = [];
         foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[$group]);
         }
 
         $mt_codes = $final_mt_codes;
@@ -260,44 +260,44 @@ 
             }
 
             // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
+            if (isset($this->_valid_shortcodes_modifier[$context][$field])) {
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $this->_valid_shortcodes_modifier[$context][$field],
                     $codes_from_objs
                 );
-            } elseif (isset($groups_per_field[ $field ])) {
+            } elseif (isset($groups_per_field[$field])) {
                 // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
+                $this->_validators[$field]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+                    $groups_per_field[$field],
                     $codes_from_objs
                 );
             } elseif (empty($config)) {
                 // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
+                $this->_validators[$field]['shortcodes'] = $mt_codes;
             } elseif (isset($config['specific_shortcodes'])) {
                 // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+                $this->_validators[$field]['shortcodes'] = $config['specific_shortcodes'];
             } else {
                 // otherwise the shortcodes are what is set by the messenger for that field
                 foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
+                    $this->_validators[$field]['shortcodes'] = isset($this->_validators[$field]['shortcodes'])
+                        ? array_merge($this->_validators[$field]['shortcodes'], $codes_from_objs[$group])
+                        : $codes_from_objs[$group];
                 }
             }
 
             // now let's just make sure that any excluded specific shortcodes are removed.
             $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+            if (isset($specific_excludes[$field])) {
+                foreach ($specific_excludes[$field] as $sex) {
+                    if (isset($this->_validators[$field]['shortcodes'][$sex])) {
+                        unset($this->_validators[$field]['shortcodes'][$sex]);
                     }
                 }
             }
 
             // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] =
+            $this->_validators[$field]['type'] =
                 isset($config['type'])
                     ? $config['type']
                     : null;
@@ -327,7 +327,7 @@ 
     {
         // specific validator filter
         $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+            'FHEE__'.get_class($this).'__get_specific_shortcode_excludes;',
             $this->_specific_shortcode_excludes,
             $this->_context
         );
@@ -354,21 +354,21 @@ 
         $template_fields = $this->_messenger->get_template_fields();
         // loop through the fields and check!
         foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
+            $this->_errors[$field] = [];
             $err_msg                 = '';
             $field_label             = '';
             // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
+            if ( ! isset($this->_validators[$field])) {
+                unset($this->_errors[$field]);
                 continue;
             }
 
             // get the translated field label!
             // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
+            if (isset($template_fields[$field])) {
                 // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
+                $field_label = ! empty($template_fields[$field])
+                    ? $template_fields[$field]['label']
                     : $field;
             }
 
@@ -392,20 +392,20 @@ 
 
             // field is present. Let's validate shortcodes first (but only if shortcodes present).
             if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
+                isset($this->_validators[$field]['shortcodes'])
+                && ! empty($this->_validators[$field]['shortcodes'])
             ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[$field]['shortcodes']);
                 // if true then that means there is a returned error message
                 // that we'll need to add to the _errors array for this field.
                 if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+                    $v_s     = array_keys($this->_validators[$field]['shortcodes']);
                     $err_msg = sprintf(
                         esc_html__(
                             '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
                             'event_espresso'
                         ),
-                        '<strong>' . $field_label . '</strong>',
+                        '<strong>'.$field_label.'</strong>',
                         $invalid_shortcodes,
                         '<p>',
                         '</p >'
@@ -420,10 +420,10 @@ 
             }
 
             // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
+            if (isset($this->_validators[$field]['type']) && ! empty($this->_validators[$field]['type'])) {
+                switch ($this->_validators[$field]['type']) {
                     case 'number':
-                        if (! is_numeric($value)) {
+                        if ( ! is_numeric($value)) {
                             $err_msg .= sprintf(
                                 esc_html__(
                                     '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
@@ -438,7 +438,7 @@ 
                         break;
                     case 'email':
                         $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
+                        if ( ! $valid_email) {
                             $err_msg .= htmlentities(
                                 sprintf(
                                     esc_html__(
@@ -456,18 +456,18 @@ 
             }
 
             // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
+            if ( ! empty($err_msg)) {
+                $this->_errors[$field]['msg'] = $err_msg;
             } else {
-                unset($this->_errors[ $field ]);
+                unset($this->_errors[$field]);
             }
         }
 
         // if we have ANY errors, then we want to make sure we return the values
         // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
+        if ( ! empty($this->_errors)) {
             foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
+                $this->_errors[$field]['value'] = stripslashes($value);
             }
         }
 
@@ -490,7 +490,7 @@ 
     {
         $shortcodes = [];
         foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+            $shortcodes = array_merge($shortcodes, $codes_from_objs[$group]);
         }
         return $shortcodes;
     }
@@ -520,8 +520,8 @@ 
                 // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
                 $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
                 // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
+                if (isset($valid_shortcodes[$dynamic_sc])) {
+                    unset($diff[$ind]);
                 }
             }
         }
@@ -532,7 +532,7 @@ 
 
         // made it here? then let's assemble the error message
         $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        return '<strong>' . $invalid_shortcodes . '</strong>';
+        return '<strong>'.$invalid_shortcodes.'</strong>';
     }
 
 
@@ -568,7 +568,7 @@ 
         // its possible that this message is being "turned off" for a particular context
 
 
-        if (! empty($or_val) && empty($value)) {
+        if ( ! empty($or_val) && empty($value)) {
             return $validate;
         }
 
@@ -627,8 +627,8 @@ 
             '_MSGTYP' => '_message_type',
         ];
 
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
+        if (isset($expected_properties_map[$property])) {
+            return $this->{$expected_properties_map[$property]};
         }
 
         throw new Exception(

Indentation +622 added lines, -622 removed lines

@@ -15,626 +15,626 @@
  */
 abstract class EE_Messages_Validator extends EE_Base
 {
-    /**
-     * These properties just hold the name for the Messenger and Message Type (defined by child classes).
-     * These are used for retrieving objects etc.
-     *
-     * @var string
-     */
-    protected $_m_name;
-
-    protected $_mt_name;
-
-
-    /**
-     * This will hold any error messages from the validation process.
-     * The _errors property holds an associative array of error messages
-     * listing the field as the key and the message as the value.
-     *
-     * @var array()
-     */
-    private $_errors = [];
-
-
-    /**
-     * holds an array of fields being validated
-     *
-     * @var array
-     */
-    protected $_fields;
-
-
-    /**
-     * this will hold the incoming context
-     *
-     * @var string
-     */
-    protected $_context;
-
-
-    /**
-     * this holds an array of fields and the relevant validation information
-     * that the incoming fields data get validated against.
-     * This gets setup in the _set_props() method.
-     *
-     * @var array
-     */
-    protected $_validators;
-
-
-    /**
-     * holds the messenger object
-     *
-     * @var object
-     */
-    protected $_messenger;
-
-
-    /**
-     * holds the message type object
-     *
-     * @var object
-     */
-    protected $_message_type;
-
-
-    /**
-     * will hold any valid_shortcode modifications made by the _modify_validator() method.
-     *
-     * @var array
-     */
-    protected $_valid_shortcodes_modifier;
-
-
-    /**
-     * There may be times where a message type wants to include a shortcode group but exclude specific
-     * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
-     * they will not be allowed.
-     * Array should be indexed by field and values are an array of specific shortcodes to exclude.
-     *
-     * @var array
-     */
-    protected $_specific_shortcode_excludes = [];
-
-
-    /**
-     * Runs the validator using the incoming fields array as the fields/values to check.
-     *
-     * @param array $fields The fields sent by the EEM object.
-     * @param       $context
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function __construct($fields, $context)
-    {
-        // check that _m_name and _mt_name have been set by child class otherwise we get out.
-        if (empty($this->_m_name) || empty($this->_mt_name)) {
-            throw new EE_Error(
-                esc_html__(
-                    'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
-                    'event_espresso'
-                )
-            );
-        }
-        $this->_fields  = $fields;
-        $this->_context = $context;
-
-        // load messenger and message_type objects and the related shortcode objects.
-        $this->_load_objects();
-
-
-        // modify any messenger/message_type specific validation instructions.  This is what child classes define.
-        $this->_modify_validator();
-
-
-        // let's set validators property
-        $this->_set_validators();
-    }
-
-
-    /**
-     * Child classes instantiate this and use it to modify the _validator_config array property
-     * for the messenger using messengers set_validate_config() method.
-     * This is so we can specify specific validation instructions for a messenger/message_type combo
-     * that aren't handled by the defaults setup in the messenger.
-     *
-     * @abstract
-     * @return void
-     */
-    abstract protected function _modify_validator();
-
-
-    /**
-     * loads all objects used by validator
-     *
-     * @throws EE_Error
-     */
-    private function _load_objects()
-    {
-        // load messenger
-        $messenger = ucwords(str_replace('_', ' ', $this->_m_name));
-        $messenger = str_replace(' ', '_', $messenger);
-        $messenger = 'EE_' . $messenger . '_messenger';
-
-        if (! class_exists($messenger)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
-                    $this->_m_name
-                )
-            );
-        }
-
-        $this->_messenger = new $messenger();
-
-        // load message type
-        $message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
-        $message_type = str_replace(' ', '_', $message_type);
-        $message_type = 'EE_' . $message_type . '_message_type';
-
-        if (! class_exists($message_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
-                    $this->_mt_name
-                )
-            );
-        }
-
-        $this->_message_type = new $message_type();
-    }
-
-
-    /**
-     * used to set the $_validators property
-     *
-     * @return void
-     * @throws ReflectionException
-     */
-    private function _set_validators()
-    {
-        // let's get all valid shortcodes from mt and message type
-        // (messenger will have its set in the _validator_config property for the messenger)
-        $mt_codes = $this->_message_type->get_valid_shortcodes();
-
-
-        // get messenger validator_config
-        $msgr_validator = $this->_messenger->get_validator_config();
-
-
-        // we only want the valid shortcodes for the given context!
-        $context  = $this->_context;
-        $mt_codes = $mt_codes[ $context ];
-
-        // in this first loop we're just getting all shortcode group indexes from the msgr_validator
-        // into a single array (so we can get the appropriate shortcode objects for the groups)
-        $shortcode_groups = $mt_codes;
-        $groups_per_field = [];
-
-        foreach ($msgr_validator as $field => $config) {
-            if (empty($config) || ! isset($config['shortcodes'])) {
-                continue;
-            }  //Nothing to see here.
-            $groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
-            $shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
-        }
-
-        $shortcode_groups = array_unique($shortcode_groups);
-
-        // okay now we've got our groups.
-        // Let's get the codes from the objects into an array indexed by group for easy retrieval later.
-        $codes_from_objs = [];
-
-        foreach ($shortcode_groups as $group) {
-            $ref       = ucwords(str_replace('_', ' ', $group));
-            $ref       = str_replace(' ', '_', $ref);
-            $classname = 'EE_' . $ref . '_Shortcodes';
-            if (class_exists($classname)) {
-                $a                         = new ReflectionClass($classname);
-                $obj                       = $a->newInstance();
-                $codes_from_objs[ $group ] = $obj->get_shortcodes();
-            }
-        }
-
-
-        // let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
-        $final_mt_codes = [];
-        foreach ($mt_codes as $group) {
-            $final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
-        }
-
-        $mt_codes = $final_mt_codes;
-
-
-        // k now in this next loop we're going to loop through $msgr_validator again
-        // and setup the _validators property from the data we've setup so far.
-        foreach ($msgr_validator as $field => $config) {
-            // if required shortcode is not in our list of codes for the given field, then we skip this field.
-            $required = isset($config['required'])
-                ? array_intersect($config['required'], array_keys($mt_codes))
-                : true;
-            if (empty($required)) {
-                continue;
-            }
-
-            // If we have an override then we use it to indicate the codes we want.
-            if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $this->_valid_shortcodes_modifier[ $context ][ $field ],
-                    $codes_from_objs
-                );
-            } elseif (isset($groups_per_field[ $field ])) {
-                // we have specific shortcodes for a field so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
-                    $groups_per_field[ $field ],
-                    $codes_from_objs
-                );
-            } elseif (empty($config)) {
-                // no config so we're assuming we're just going to use the shortcodes from the message type context
-                $this->_validators[ $field ]['shortcodes'] = $mt_codes;
-            } elseif (isset($config['specific_shortcodes'])) {
-                // we have specific shortcodes so we need to use them
-                $this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
-            } else {
-                // otherwise the shortcodes are what is set by the messenger for that field
-                foreach ($config['shortcodes'] as $group) {
-                    $this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
-                        ? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
-                        : $codes_from_objs[ $group ];
-                }
-            }
-
-            // now let's just make sure that any excluded specific shortcodes are removed.
-            $specific_excludes = $this->get_specific_shortcode_excludes();
-            if (isset($specific_excludes[ $field ])) {
-                foreach ($specific_excludes[ $field ] as $sex) {
-                    if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
-                        unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
-                    }
-                }
-            }
-
-            // hey! don't forget to include the type if present!
-            $this->_validators[ $field ]['type'] =
-                isset($config['type'])
-                    ? $config['type']
-                    : null;
-        }
-    }
-
-
-    /**
-     * This just returns the validators property that contains information
-     * about the various shortcodes and their availability with each field
-     *
-     * @return array
-     */
-    public function get_validators()
-    {
-        return $this->_validators;
-    }
-
-
-    /**
-     * This simply returns the specific shortcode_excludes property that is set.
-     *
-     * @return array
-     * @since 4.5.0
-     */
-    public function get_specific_shortcode_excludes()
-    {
-        // specific validator filter
-        $shortcode_excludes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
-            $this->_specific_shortcode_excludes,
-            $this->_context
-        );
-        // global filter
-        return apply_filters(
-            'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
-            $shortcode_excludes,
-            $this->_context,
-            $this
-        );
-    }
-
-
-    /**
-     * This is the main method that handles validation
-     * What it does is loop through the _fields (the ones that get validated)
-     * and checks them against the shortcodes array for the field and the 'type' indicated by the
-     *
-     * @return array|bool if errors present we return the array otherwise true
-     */
-    public function validate()
-    {
-        // some defaults
-        $template_fields = $this->_messenger->get_template_fields();
-        // loop through the fields and check!
-        foreach ($this->_fields as $field => $value) {
-            $this->_errors[ $field ] = [];
-            $err_msg                 = '';
-            $field_label             = '';
-            // if field is not present in the _validators array then we continue
-            if (! isset($this->_validators[ $field ])) {
-                unset($this->_errors[ $field ]);
-                continue;
-            }
-
-            // get the translated field label!
-            // first check if it's in the main fields list
-            if (isset($template_fields[ $field ])) {
-                // most likely the field is found in the 'extra' array.
-                $field_label = ! empty($template_fields[ $field ])
-                    ? $template_fields[ $field ]['label']
-                    : $field;
-            }
-
-            // if field label is empty OR is equal to the current field
-            // then we need to loop through the 'extra' fields in the template_fields config (if present)
-            if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
-                foreach ($template_fields['extra'] as $main_field => $secondary_field) {
-                    foreach ($secondary_field as $name => $values) {
-                        if ($name === $field) {
-                            $field_label = $values['label'];
-                        }
-
-                        // if we've got a 'main' secondary field, let's see if that matches what field we're on
-                        // which means it contains the label for this field.
-                        if ($name === 'main' && $main_field === $field_label) {
-                            $field_label = $values['label'];
-                        }
-                    }
-                }
-            }
-
-            // field is present. Let's validate shortcodes first (but only if shortcodes present).
-            if (
-                isset($this->_validators[ $field ]['shortcodes'])
-                && ! empty($this->_validators[ $field ]['shortcodes'])
-            ) {
-                $invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
-                // if true then that means there is a returned error message
-                // that we'll need to add to the _errors array for this field.
-                if ($invalid_shortcodes) {
-                    $v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
-                    $err_msg = sprintf(
-                        esc_html__(
-                            '%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
-                            'event_espresso'
-                        ),
-                        '<strong>' . $field_label . '</strong>',
-                        $invalid_shortcodes,
-                        '<p>',
-                        '</p >'
-                    );
-                    $err_msg .= sprintf(
-                        esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
-                        implode(', ', $v_s),
-                        '<strong>',
-                        '</strong>'
-                    );
-                }
-            }
-
-            // if there's a "type" to be validated then let's do that too.
-            if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
-                switch ($this->_validators[ $field ]['type']) {
-                    case 'number':
-                        if (! is_numeric($value)) {
-                            $err_msg .= sprintf(
-                                esc_html__(
-                                    '%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
-                                    'event_espresso'
-                                ),
-                                $field_label,
-                                $value,
-                                '<p>',
-                                '</p >'
-                            );
-                        }
-                        break;
-                    case 'email':
-                        $valid_email = $this->_validate_email($value);
-                        if (! $valid_email) {
-                            $err_msg .= htmlentities(
-                                sprintf(
-                                    esc_html__(
-                                        'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
-                                        'event_espresso'
-                                    ),
-                                    $field_label
-                                )
-                            );
-                        }
-                        break;
-                    default:
-                        break;
-                }
-            }
-
-            // if $err_msg isn't empty let's setup the _errors array for this field.
-            if (! empty($err_msg)) {
-                $this->_errors[ $field ]['msg'] = $err_msg;
-            } else {
-                unset($this->_errors[ $field ]);
-            }
-        }
-
-        // if we have ANY errors, then we want to make sure we return the values
-        // for ALL the fields so the user doesn't have to retype them all.
-        if (! empty($this->_errors)) {
-            foreach ($this->_fields as $field => $value) {
-                $this->_errors[ $field ]['value'] = stripslashes($value);
-            }
-        }
-
-        // return any errors or just TRUE if everything validates
-        return empty($this->_errors)
-            ? true
-            : $this->_errors;
-    }
-
-
-    /**
-     * Reassembles and returns an array of valid shortcodes
-     * given the array of groups and array of shortcodes indexed by group.
-     *
-     * @param array $groups          array of shortcode groups that we want shortcodes for
-     * @param array $codes_from_objs All the codes available.
-     * @return array                   an array of actual shortcodes (that will be used for validation).
-     */
-    private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
-    {
-        $shortcodes = [];
-        foreach ($groups as $group) {
-            $shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
-        }
-        return $shortcodes;
-    }
-
-
-    /**
-     * Validates a string against a list of accepted shortcodes
-     * This function takes in an array of shortcodes
-     * and makes sure that the given string ONLY contains shortcodes in that array.
-     *
-     * @param string $value            string to evaluate
-     * @param array  $valid_shortcodes array of shortcodes that are acceptable.
-     * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
-     */
-    protected function _invalid_shortcodes($value, $valid_shortcodes)
-    {
-        // first we need to go through the string and get the shortcodes in the string
-        preg_match_all('/(\[.+?\])/', $value, $matches);
-        $incoming_shortcodes = (array) $matches[0];
-
-        // get a diff of the shortcodes in the string vs the valid shortcodes
-        $diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
-
-        // we need to account for custom codes so let's loop through the diff and remove any of those type of codes
-        foreach ($diff as $ind => $code) {
-            if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
-                // strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
-                $dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
-                // does this exist in the $valid_shortcodes?  If so then unset.
-                if (isset($valid_shortcodes[ $dynamic_sc ])) {
-                    unset($diff[ $ind ]);
-                }
-            }
-        }
-
-        if (empty($diff)) {
-            return false;
-        } //there is no diff, we have no invalid shortcodes, so return
-
-        // made it here? then let's assemble the error message
-        $invalid_shortcodes = implode('</strong>,<strong>', $diff);
-        return '<strong>' . $invalid_shortcodes . '</strong>';
-    }
-
-
-    /**
-     * Validates an incoming string and makes sure we have valid emails in the string.
-     *
-     * @param string $value incoming value to validate
-     * @return bool        true if the string validates, false if it doesn't
-     */
-    protected function _validate_email($value)
-    {
-        $validate = true;
-        $or_val   = $value;
-
-        // empty strings will validate because this is how a message template
-        // for a particular context can be "turned off" (if there is no email then no message)
-        if (empty($value)) {
-            return $validate;
-        }
-
-        // first determine if there ARE any shortcodes.
-        // If there are shortcodes and then later we find that there were no other valid emails
-        // but the field isn't empty...
-        // that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
-        $has_shortcodes = preg_match('/(\[.+?\])/', $value);
-
-        // first we need to strip out all the shortcodes!
-        $value = preg_replace('/(\[.+?\])/', '', $value);
-
-        // if original value is not empty and new value is, then we've parsed out a shortcode
-        // and we now have an empty string which DOES validate.
-        // We also validate complete empty field for email because
-        // its possible that this message is being "turned off" for a particular context
-
-
-        if (! empty($or_val) && empty($value)) {
-            return $validate;
-        }
-
-        // trim any commas from beginning and end of string ( after whitespace trimmed );
-        $value = trim(trim($value), ',');
-
-
-        // next we need to split up the string if its comma delimited.
-        $emails = explode(',', $value);
-        $empty  = false; // used to indicate that there is an empty comma.
-        // now let's loop through the emails and do our checks
-        foreach ($emails as $email) {
-            if (empty($email)) {
-                $empty = true;
-                continue;
-            }
-
-            // trim whitespace
-            $email = trim($email);
-            // either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
-            if (is_email($email)) {
-                continue;
-            }
-            $matches  = [];
-            $validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
-            if ($validate && is_email($matches[2])) {
-                continue;
-            }
-            return false;
-        }
-
-        return $empty && ! $has_shortcodes
-            ? false
-            : $validate;
-    }
-
-
-    /**
-     * Magic getter
-     * Using this to provide back compat with add-ons referencing deprecated properties.
-     *
-     * @param string $property Property being requested
-     * @return mixed
-     * @throws Exception
-     */
-    public function __get($property)
-    {
-        $expected_properties_map = [
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGR'   => '_messenger',
-            /**
-             * @deprecated 4.9.0
-             */
-            '_MSGTYP' => '_message_type',
-        ];
-
-        if (isset($expected_properties_map[ $property ])) {
-            return $this->{$expected_properties_map[ $property ]};
-        }
-
-        throw new Exception(
-            sprintf(
-                esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
-                $property,
-                get_class($this)
-            )
-        );
-    }
+	/**
+	 * These properties just hold the name for the Messenger and Message Type (defined by child classes).
+	 * These are used for retrieving objects etc.
+	 *
+	 * @var string
+	 */
+	protected $_m_name;
+
+	protected $_mt_name;
+
+
+	/**
+	 * This will hold any error messages from the validation process.
+	 * The _errors property holds an associative array of error messages
+	 * listing the field as the key and the message as the value.
+	 *
+	 * @var array()
+	 */
+	private $_errors = [];
+
+
+	/**
+	 * holds an array of fields being validated
+	 *
+	 * @var array
+	 */
+	protected $_fields;
+
+
+	/**
+	 * this will hold the incoming context
+	 *
+	 * @var string
+	 */
+	protected $_context;
+
+
+	/**
+	 * this holds an array of fields and the relevant validation information
+	 * that the incoming fields data get validated against.
+	 * This gets setup in the _set_props() method.
+	 *
+	 * @var array
+	 */
+	protected $_validators;
+
+
+	/**
+	 * holds the messenger object
+	 *
+	 * @var object
+	 */
+	protected $_messenger;
+
+
+	/**
+	 * holds the message type object
+	 *
+	 * @var object
+	 */
+	protected $_message_type;
+
+
+	/**
+	 * will hold any valid_shortcode modifications made by the _modify_validator() method.
+	 *
+	 * @var array
+	 */
+	protected $_valid_shortcodes_modifier;
+
+
+	/**
+	 * There may be times where a message type wants to include a shortcode group but exclude specific
+	 * shortcodes.  If that's the case then it can set this property as an array of shortcodes to exclude and
+	 * they will not be allowed.
+	 * Array should be indexed by field and values are an array of specific shortcodes to exclude.
+	 *
+	 * @var array
+	 */
+	protected $_specific_shortcode_excludes = [];
+
+
+	/**
+	 * Runs the validator using the incoming fields array as the fields/values to check.
+	 *
+	 * @param array $fields The fields sent by the EEM object.
+	 * @param       $context
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function __construct($fields, $context)
+	{
+		// check that _m_name and _mt_name have been set by child class otherwise we get out.
+		if (empty($this->_m_name) || empty($this->_mt_name)) {
+			throw new EE_Error(
+				esc_html__(
+					'EE_Messages_Validator child classes MUST set the $_m_name and $_mt_name property.  Check that the child class is doing this',
+					'event_espresso'
+				)
+			);
+		}
+		$this->_fields  = $fields;
+		$this->_context = $context;
+
+		// load messenger and message_type objects and the related shortcode objects.
+		$this->_load_objects();
+
+
+		// modify any messenger/message_type specific validation instructions.  This is what child classes define.
+		$this->_modify_validator();
+
+
+		// let's set validators property
+		$this->_set_validators();
+	}
+
+
+	/**
+	 * Child classes instantiate this and use it to modify the _validator_config array property
+	 * for the messenger using messengers set_validate_config() method.
+	 * This is so we can specify specific validation instructions for a messenger/message_type combo
+	 * that aren't handled by the defaults setup in the messenger.
+	 *
+	 * @abstract
+	 * @return void
+	 */
+	abstract protected function _modify_validator();
+
+
+	/**
+	 * loads all objects used by validator
+	 *
+	 * @throws EE_Error
+	 */
+	private function _load_objects()
+	{
+		// load messenger
+		$messenger = ucwords(str_replace('_', ' ', $this->_m_name));
+		$messenger = str_replace(' ', '_', $messenger);
+		$messenger = 'EE_' . $messenger . '_messenger';
+
+		if (! class_exists($messenger)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no messenger class for the given string (%s)', 'event_espresso'),
+					$this->_m_name
+				)
+			);
+		}
+
+		$this->_messenger = new $messenger();
+
+		// load message type
+		$message_type = ucwords(str_replace('_', ' ', $this->_mt_name));
+		$message_type = str_replace(' ', '_', $message_type);
+		$message_type = 'EE_' . $message_type . '_message_type';
+
+		if (! class_exists($message_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no message type class for the given string (%s)', 'event_espresso'),
+					$this->_mt_name
+				)
+			);
+		}
+
+		$this->_message_type = new $message_type();
+	}
+
+
+	/**
+	 * used to set the $_validators property
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 */
+	private function _set_validators()
+	{
+		// let's get all valid shortcodes from mt and message type
+		// (messenger will have its set in the _validator_config property for the messenger)
+		$mt_codes = $this->_message_type->get_valid_shortcodes();
+
+
+		// get messenger validator_config
+		$msgr_validator = $this->_messenger->get_validator_config();
+
+
+		// we only want the valid shortcodes for the given context!
+		$context  = $this->_context;
+		$mt_codes = $mt_codes[ $context ];
+
+		// in this first loop we're just getting all shortcode group indexes from the msgr_validator
+		// into a single array (so we can get the appropriate shortcode objects for the groups)
+		$shortcode_groups = $mt_codes;
+		$groups_per_field = [];
+
+		foreach ($msgr_validator as $field => $config) {
+			if (empty($config) || ! isset($config['shortcodes'])) {
+				continue;
+			}  //Nothing to see here.
+			$groups_per_field[ $field ] = array_intersect($config['shortcodes'], $mt_codes);
+			$shortcode_groups           = array_merge($config['shortcodes'], $shortcode_groups);
+		}
+
+		$shortcode_groups = array_unique($shortcode_groups);
+
+		// okay now we've got our groups.
+		// Let's get the codes from the objects into an array indexed by group for easy retrieval later.
+		$codes_from_objs = [];
+
+		foreach ($shortcode_groups as $group) {
+			$ref       = ucwords(str_replace('_', ' ', $group));
+			$ref       = str_replace(' ', '_', $ref);
+			$classname = 'EE_' . $ref . '_Shortcodes';
+			if (class_exists($classname)) {
+				$a                         = new ReflectionClass($classname);
+				$obj                       = $a->newInstance();
+				$codes_from_objs[ $group ] = $obj->get_shortcodes();
+			}
+		}
+
+
+		// let's just replace the $mt shortcode group indexes with the actual shortcodes (unique)
+		$final_mt_codes = [];
+		foreach ($mt_codes as $group) {
+			$final_mt_codes = array_merge($final_mt_codes, $codes_from_objs[ $group ]);
+		}
+
+		$mt_codes = $final_mt_codes;
+
+
+		// k now in this next loop we're going to loop through $msgr_validator again
+		// and setup the _validators property from the data we've setup so far.
+		foreach ($msgr_validator as $field => $config) {
+			// if required shortcode is not in our list of codes for the given field, then we skip this field.
+			$required = isset($config['required'])
+				? array_intersect($config['required'], array_keys($mt_codes))
+				: true;
+			if (empty($required)) {
+				continue;
+			}
+
+			// If we have an override then we use it to indicate the codes we want.
+			if (isset($this->_valid_shortcodes_modifier[ $context ][ $field ])) {
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$this->_valid_shortcodes_modifier[ $context ][ $field ],
+					$codes_from_objs
+				);
+			} elseif (isset($groups_per_field[ $field ])) {
+				// we have specific shortcodes for a field so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $this->_reassemble_valid_shortcodes_from_group(
+					$groups_per_field[ $field ],
+					$codes_from_objs
+				);
+			} elseif (empty($config)) {
+				// no config so we're assuming we're just going to use the shortcodes from the message type context
+				$this->_validators[ $field ]['shortcodes'] = $mt_codes;
+			} elseif (isset($config['specific_shortcodes'])) {
+				// we have specific shortcodes so we need to use them
+				$this->_validators[ $field ]['shortcodes'] = $config['specific_shortcodes'];
+			} else {
+				// otherwise the shortcodes are what is set by the messenger for that field
+				foreach ($config['shortcodes'] as $group) {
+					$this->_validators[ $field ]['shortcodes'] = isset($this->_validators[ $field ]['shortcodes'])
+						? array_merge($this->_validators[ $field ]['shortcodes'], $codes_from_objs[ $group ])
+						: $codes_from_objs[ $group ];
+				}
+			}
+
+			// now let's just make sure that any excluded specific shortcodes are removed.
+			$specific_excludes = $this->get_specific_shortcode_excludes();
+			if (isset($specific_excludes[ $field ])) {
+				foreach ($specific_excludes[ $field ] as $sex) {
+					if (isset($this->_validators[ $field ]['shortcodes'][ $sex ])) {
+						unset($this->_validators[ $field ]['shortcodes'][ $sex ]);
+					}
+				}
+			}
+
+			// hey! don't forget to include the type if present!
+			$this->_validators[ $field ]['type'] =
+				isset($config['type'])
+					? $config['type']
+					: null;
+		}
+	}
+
+
+	/**
+	 * This just returns the validators property that contains information
+	 * about the various shortcodes and their availability with each field
+	 *
+	 * @return array
+	 */
+	public function get_validators()
+	{
+		return $this->_validators;
+	}
+
+
+	/**
+	 * This simply returns the specific shortcode_excludes property that is set.
+	 *
+	 * @return array
+	 * @since 4.5.0
+	 */
+	public function get_specific_shortcode_excludes()
+	{
+		// specific validator filter
+		$shortcode_excludes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_specific_shortcode_excludes;',
+			$this->_specific_shortcode_excludes,
+			$this->_context
+		);
+		// global filter
+		return apply_filters(
+			'FHEE__EE_Messages_Validator__get_specific_shortcode_excludes',
+			$shortcode_excludes,
+			$this->_context,
+			$this
+		);
+	}
+
+
+	/**
+	 * This is the main method that handles validation
+	 * What it does is loop through the _fields (the ones that get validated)
+	 * and checks them against the shortcodes array for the field and the 'type' indicated by the
+	 *
+	 * @return array|bool if errors present we return the array otherwise true
+	 */
+	public function validate()
+	{
+		// some defaults
+		$template_fields = $this->_messenger->get_template_fields();
+		// loop through the fields and check!
+		foreach ($this->_fields as $field => $value) {
+			$this->_errors[ $field ] = [];
+			$err_msg                 = '';
+			$field_label             = '';
+			// if field is not present in the _validators array then we continue
+			if (! isset($this->_validators[ $field ])) {
+				unset($this->_errors[ $field ]);
+				continue;
+			}
+
+			// get the translated field label!
+			// first check if it's in the main fields list
+			if (isset($template_fields[ $field ])) {
+				// most likely the field is found in the 'extra' array.
+				$field_label = ! empty($template_fields[ $field ])
+					? $template_fields[ $field ]['label']
+					: $field;
+			}
+
+			// if field label is empty OR is equal to the current field
+			// then we need to loop through the 'extra' fields in the template_fields config (if present)
+			if (isset($template_fields['extra']) && (empty($field_label) || $field_label === $field)) {
+				foreach ($template_fields['extra'] as $main_field => $secondary_field) {
+					foreach ($secondary_field as $name => $values) {
+						if ($name === $field) {
+							$field_label = $values['label'];
+						}
+
+						// if we've got a 'main' secondary field, let's see if that matches what field we're on
+						// which means it contains the label for this field.
+						if ($name === 'main' && $main_field === $field_label) {
+							$field_label = $values['label'];
+						}
+					}
+				}
+			}
+
+			// field is present. Let's validate shortcodes first (but only if shortcodes present).
+			if (
+				isset($this->_validators[ $field ]['shortcodes'])
+				&& ! empty($this->_validators[ $field ]['shortcodes'])
+			) {
+				$invalid_shortcodes = $this->_invalid_shortcodes($value, $this->_validators[ $field ]['shortcodes']);
+				// if true then that means there is a returned error message
+				// that we'll need to add to the _errors array for this field.
+				if ($invalid_shortcodes) {
+					$v_s     = array_keys($this->_validators[ $field ]['shortcodes']);
+					$err_msg = sprintf(
+						esc_html__(
+							'%3$sThe following shortcodes were found in the "%1$s" field that ARE not valid: %2$s%4$s',
+							'event_espresso'
+						),
+						'<strong>' . $field_label . '</strong>',
+						$invalid_shortcodes,
+						'<p>',
+						'</p >'
+					);
+					$err_msg .= sprintf(
+						esc_html__('%2$sValid shortcodes for this field are: %1$s%3$s', 'event_espresso'),
+						implode(', ', $v_s),
+						'<strong>',
+						'</strong>'
+					);
+				}
+			}
+
+			// if there's a "type" to be validated then let's do that too.
+			if (isset($this->_validators[ $field ]['type']) && ! empty($this->_validators[ $field ]['type'])) {
+				switch ($this->_validators[ $field ]['type']) {
+					case 'number':
+						if (! is_numeric($value)) {
+							$err_msg .= sprintf(
+								esc_html__(
+									'%3$sThe %1$s field is supposed to be a number. The value given (%2$s)  is not.  Please double-check and make sure the field contains a number%4$s',
+									'event_espresso'
+								),
+								$field_label,
+								$value,
+								'<p>',
+								'</p >'
+							);
+						}
+						break;
+					case 'email':
+						$valid_email = $this->_validate_email($value);
+						if (! $valid_email) {
+							$err_msg .= htmlentities(
+								sprintf(
+									esc_html__(
+										'The %1$s field has at least one string that is not a valid email address record.  Valid emails are in the format: "Name <email@something.com>" or "email@something.com" and multiple emails can be separated by a comma.',
+										'event_espresso'
+									),
+									$field_label
+								)
+							);
+						}
+						break;
+					default:
+						break;
+				}
+			}
+
+			// if $err_msg isn't empty let's setup the _errors array for this field.
+			if (! empty($err_msg)) {
+				$this->_errors[ $field ]['msg'] = $err_msg;
+			} else {
+				unset($this->_errors[ $field ]);
+			}
+		}
+
+		// if we have ANY errors, then we want to make sure we return the values
+		// for ALL the fields so the user doesn't have to retype them all.
+		if (! empty($this->_errors)) {
+			foreach ($this->_fields as $field => $value) {
+				$this->_errors[ $field ]['value'] = stripslashes($value);
+			}
+		}
+
+		// return any errors or just TRUE if everything validates
+		return empty($this->_errors)
+			? true
+			: $this->_errors;
+	}
+
+
+	/**
+	 * Reassembles and returns an array of valid shortcodes
+	 * given the array of groups and array of shortcodes indexed by group.
+	 *
+	 * @param array $groups          array of shortcode groups that we want shortcodes for
+	 * @param array $codes_from_objs All the codes available.
+	 * @return array                   an array of actual shortcodes (that will be used for validation).
+	 */
+	private function _reassemble_valid_shortcodes_from_group($groups, $codes_from_objs)
+	{
+		$shortcodes = [];
+		foreach ($groups as $group) {
+			$shortcodes = array_merge($shortcodes, $codes_from_objs[ $group ]);
+		}
+		return $shortcodes;
+	}
+
+
+	/**
+	 * Validates a string against a list of accepted shortcodes
+	 * This function takes in an array of shortcodes
+	 * and makes sure that the given string ONLY contains shortcodes in that array.
+	 *
+	 * @param string $value            string to evaluate
+	 * @param array  $valid_shortcodes array of shortcodes that are acceptable.
+	 * @return bool|string  return either a list of invalid shortcodes OR false if the shortcodes validate.
+	 */
+	protected function _invalid_shortcodes($value, $valid_shortcodes)
+	{
+		// first we need to go through the string and get the shortcodes in the string
+		preg_match_all('/(\[.+?\])/', $value, $matches);
+		$incoming_shortcodes = (array) $matches[0];
+
+		// get a diff of the shortcodes in the string vs the valid shortcodes
+		$diff = array_diff($incoming_shortcodes, array_keys($valid_shortcodes));
+
+		// we need to account for custom codes so let's loop through the diff and remove any of those type of codes
+		foreach ($diff as $ind => $code) {
+			if (preg_match('/(\[[A-Za-z0-9\_]+_\*)/', $code)) {
+				// strip the shortcode so we just have the BASE string (i.e. [ANSWER_*] )
+				$dynamic_sc = preg_replace('/(_\*+.+)/', '_*]', $code);
+				// does this exist in the $valid_shortcodes?  If so then unset.
+				if (isset($valid_shortcodes[ $dynamic_sc ])) {
+					unset($diff[ $ind ]);
+				}
+			}
+		}
+
+		if (empty($diff)) {
+			return false;
+		} //there is no diff, we have no invalid shortcodes, so return
+
+		// made it here? then let's assemble the error message
+		$invalid_shortcodes = implode('</strong>,<strong>', $diff);
+		return '<strong>' . $invalid_shortcodes . '</strong>';
+	}
+
+
+	/**
+	 * Validates an incoming string and makes sure we have valid emails in the string.
+	 *
+	 * @param string $value incoming value to validate
+	 * @return bool        true if the string validates, false if it doesn't
+	 */
+	protected function _validate_email($value)
+	{
+		$validate = true;
+		$or_val   = $value;
+
+		// empty strings will validate because this is how a message template
+		// for a particular context can be "turned off" (if there is no email then no message)
+		if (empty($value)) {
+			return $validate;
+		}
+
+		// first determine if there ARE any shortcodes.
+		// If there are shortcodes and then later we find that there were no other valid emails
+		// but the field isn't empty...
+		// that means we've got extra commas that were left after stripping out shortcodes so probably still valid.
+		$has_shortcodes = preg_match('/(\[.+?\])/', $value);
+
+		// first we need to strip out all the shortcodes!
+		$value = preg_replace('/(\[.+?\])/', '', $value);
+
+		// if original value is not empty and new value is, then we've parsed out a shortcode
+		// and we now have an empty string which DOES validate.
+		// We also validate complete empty field for email because
+		// its possible that this message is being "turned off" for a particular context
+
+
+		if (! empty($or_val) && empty($value)) {
+			return $validate;
+		}
+
+		// trim any commas from beginning and end of string ( after whitespace trimmed );
+		$value = trim(trim($value), ',');
+
+
+		// next we need to split up the string if its comma delimited.
+		$emails = explode(',', $value);
+		$empty  = false; // used to indicate that there is an empty comma.
+		// now let's loop through the emails and do our checks
+		foreach ($emails as $email) {
+			if (empty($email)) {
+				$empty = true;
+				continue;
+			}
+
+			// trim whitespace
+			$email = trim($email);
+			// either its of type "bob@whatever.com", or its of type "fname lname <few@few.few>"
+			if (is_email($email)) {
+				continue;
+			}
+			$matches  = [];
+			$validate = (bool) preg_match('/(.*)<(.+)>/', $email, $matches);
+			if ($validate && is_email($matches[2])) {
+				continue;
+			}
+			return false;
+		}
+
+		return $empty && ! $has_shortcodes
+			? false
+			: $validate;
+	}
+
+
+	/**
+	 * Magic getter
+	 * Using this to provide back compat with add-ons referencing deprecated properties.
+	 *
+	 * @param string $property Property being requested
+	 * @return mixed
+	 * @throws Exception
+	 */
+	public function __get($property)
+	{
+		$expected_properties_map = [
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGR'   => '_messenger',
+			/**
+			 * @deprecated 4.9.0
+			 */
+			'_MSGTYP' => '_message_type',
+		];
+
+		if (isset($expected_properties_map[ $property ])) {
+			return $this->{$expected_properties_map[ $property ]};
+		}
+
+		throw new Exception(
+			sprintf(
+				esc_html__('The property %1$s being requested on %2$s does not exist', 'event_espresso'),
+				$property,
+				get_class($this)
+			)
+		);
+	}
 }