eventespresso / event-espresso-core

core/db_models/EEM_Payment_Method.model.php

Indentation +376 added lines, -376 removed lines

@@ -20,380 +20,380 @@
 class EEM_Payment_Method extends EEM_Base
 {
 
-    const scope_cart = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api = 'API';
-
-    /**
-     *
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-
-    /**
-     * private constructor to prevent direct creation
-     * @Constructor
-     * @access   protected
-     * @return EEM_Payment_Method
-     */
-    protected function __construct($timezone = null)
-    {
-        $this->singlular_item = __('Payment Method', 'event_espresso');
-        $this->plural_item = __('Payment Methods', 'event_espresso');
-        $this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
-        $this->_fields = array(
-            'Payment_Method' => array(
-                'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
-                'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
-                'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
-                'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
-                'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
-                'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
-                'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
-                'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
-                'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
-                'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
-                'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
-                'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
-        ) );
-        $this->_model_relations = array(
-            'Payment' => new EE_Has_Many_Relation(),
-            'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        );
-        parent::__construct($timezone);
-    }
-
-
-
-    /**
-     * Gets one by the slug provided
-     * @param string $slug
-     * @return EE_Payment_Method
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
-    }
-
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            array(
-                self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
-                self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
-            )
-        );
-    }
-
-
-
-    /**
-     * Determines if this is an valid scope
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Gets all active payment methods
-     * @param string $scope one of
-     * @param array  $query_params
-     * @throws EE_Error
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_active($scope = null, $query_params = array())
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Counts all active gateways in the specified scope
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array $query_params
-     * @return int
-     */
-    public function count_active($scope = null, $query_params = array())
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
-            } else {
-                throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
-            }
-        } else {
-            $acceptable_scopes = array();
-            $count = 0;
-            foreach ($this->scopes() as $scope_name => $desc) {
-                $count++;
-                $acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
-            }
-            return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
-        }
-    }
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @throws EE_Error
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = array())
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Payment_Method
-     */
-    public function get_one_active($scope = null, $query_params = array())
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     * @param string $type
-     * @return EE_Payment_Method
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one(array( array( 'PMD_type' => $type ) ));
-    }
-
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     * @see EEM_Base::ensure_is_obj()
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Payment_Method
-     * @throws EE_Error
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
-    }
-
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
-     * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                $current_button_url = $payment_method->button_url();
-                $buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
-                    'current_ssl' => str_replace("http://", "https://", $current_button_url),
-                    'current' => str_replace("https://", "http://", $current_button_url),
-                    'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
-                    'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
-                ));
-                foreach ($buttons_urls_to_try as $button_url_to_try) {
-                    if ((// this is the current url and it exists, regardless of SSL issues
-                                $button_url_to_try == $current_button_url &&
-                                EEH_URL::remote_file_exists(
-                                    $button_url_to_try,
-                                    array(
-                                            'sslverify' => false,
-                                            'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
-                                            )
-                                )
-                            )
-                            ||
-                            (// this is NOT the current url and it exists with a working SSL cert
-                                $button_url_to_try != $current_button_url &&
-                                EEH_URL::remote_file_exists($button_url_to_try)
-                            ) ) {
-                        if ($current_button_url != $button_url_to_try) {
-                            $payment_method->save(array( 'PMD_button_url' => $button_url_to_try ));
-                            EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
-                        }
-                        // this image exists. So if wasn't set before, now it is;
-                        // or if it was already set, we have nothing to do
-                        break;
-                    }
-                }
-            } catch (EE_Error $e) {
-                $payment_method->set_active(false);
-            }
-        }
-    }
-
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws InvalidDataTypeException
-     */
-    protected function _create_objects($rows = array())
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = array();
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        __(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     * @param EE_Transaction $transaction
-     * @param string    $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     *
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
-     * It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
-     * @return EE_Payment|null
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = array(
-            0 => array(
-                'Payment.Registration.REG_ID' => $registration_id,
-            ),
-            'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
-        );
-        return $this->get_one($query_params);
-    }
+	const scope_cart = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api = 'API';
+
+	/**
+	 *
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 * @Constructor
+	 * @access   protected
+	 * @return EEM_Payment_Method
+	 */
+	protected function __construct($timezone = null)
+	{
+		$this->singlular_item = __('Payment Method', 'event_espresso');
+		$this->plural_item = __('Payment Methods', 'event_espresso');
+		$this->_tables = array( 'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID') );
+		$this->_fields = array(
+			'Payment_Method' => array(
+				'PMD_ID' => new EE_Primary_Key_Int_Field('PMD_ID', __("ID", 'event_espresso')),
+				'PMD_type' => new EE_Plain_Text_Field('PMD_type', __("Payment Method Type", 'event_espresso'), false, 'Admin_Only'),
+				'PMD_name' => new EE_Plain_Text_Field('PMD_name', __("Name", 'event_espresso'), false),
+				'PMD_desc' => new EE_Post_Content_Field('PMD_desc', __("Description", 'event_espresso'), false, ''),
+				'PMD_admin_name' => new EE_Plain_Text_Field('PMD_admin_name', __("Admin-Only Name", 'event_espresso'), true),
+				'PMD_admin_desc' => new EE_Post_Content_Field('PMD_admin_desc', __("Admin-Only Description", 'event_espresso'), true),
+				'PMD_slug' => new EE_Slug_Field('PMD_slug', __("Slug", 'event_espresso'), false),
+				'PMD_order' => new EE_Integer_Field('PMD_order', __("Order", 'event_espresso'), false, 0),
+				'PMD_debug_mode' => new EE_Boolean_Field('PMD_debug_mode', __("Debug Mode On?", 'event_espresso'), false, false),
+				'PMD_wp_user' => new EE_WP_User_Field('PMD_wp_user', __("Payment Method Creator ID", 'event_espresso'), false),
+				'PMD_open_by_default' => new EE_Boolean_Field('PMD_open_by_default', __("Open by Default?", 'event_espresso'), false, false), 'PMD_button_url' => new EE_Plain_Text_Field('PMD_button_url', __("Button URL", 'event_espresso'), true, ''),
+				'PMD_scope' => new EE_Serialized_Text_Field('PMD_scope', __("Usable From?", 'event_espresso'), false, array()), // possible values currently are 'CART','ADMIN','API'
+		) );
+		$this->_model_relations = array(
+			'Payment' => new EE_Has_Many_Relation(),
+			'Currency' => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		);
+		parent::__construct($timezone);
+	}
+
+
+
+	/**
+	 * Gets one by the slug provided
+	 * @param string $slug
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one(array( array( 'PMD_slug' => $slug ) ));
+	}
+
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			array(
+				self::scope_cart        => __("Front-end Registration Page", 'event_espresso'),
+				self::scope_admin   => __("Admin Registration Page (no online processing)", 'event_espresso')
+			)
+		);
+	}
+
+
+
+	/**
+	 * Determines if this is an valid scope
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Gets all active payment methods
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @throws EE_Error
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_active($scope = null, $query_params = array())
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = array( 'PMD_order' => 'ASC', 'PMD_ID' => 'ASC' );
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array $query_params
+	 * @return int
+	 */
+	public function count_active($scope = null, $query_params = array())
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive(array( array( 'PMD_scope' => array( 'LIKE', "%$scope%" ) ) ), $query_params);
+			} else {
+				throw new EE_Error(sprintf(__("'%s' is not a valid scope for a payment method", "event_espresso"), $scope));
+			}
+		} else {
+			$acceptable_scopes = array();
+			$count = 0;
+			foreach ($this->scopes() as $scope_name => $desc) {
+				$count++;
+				$acceptable_scopes[ 'PMD_scope*' . $count ] = array( 'LIKE', '%' . $scope_name . '%' );
+			}
+			return array_replace_recursive(array( array( 'OR*active_scope' => $acceptable_scopes ) ), $query_params);
+		}
+	}
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array $query_params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return array @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @throws EE_Error
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = array())
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_active($scope = null, $query_params = array())
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 * @param string $type
+	 * @return EE_Payment_Method
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one(array( array( 'PMD_type' => $type ) ));
+	}
+
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 * @see EEM_Base::ensure_is_obj()
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Payment_Method
+	 * @throws EE_Error
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(sprintf(__("'%s' is neither a Payment Method ID, slug, nor object.", "event_espresso"), $base_class_obj_or_id));
+	}
+
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url. If not, resets them to their default.
+	 * @param EE_Payment_Method[] $payment_methods. If NULL is provided defaults to all payment methods active in the cart
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods) ? $payment_methods : $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				$current_button_url = $payment_method->button_url();
+				$buttons_urls_to_try = apply_filters('FHEE__EEM_Payment_Method__verify_button_urls__button_urls_to_try', array(
+					'current_ssl' => str_replace("http://", "https://", $current_button_url),
+					'current' => str_replace("https://", "http://", $current_button_url),
+					'default_ssl' => str_replace("http://", "https://", $payment_method->type_obj()->default_button_url()),
+					'default' => str_replace("https://", "http://", $payment_method->type_obj()->default_button_url()),
+				));
+				foreach ($buttons_urls_to_try as $button_url_to_try) {
+					if ((// this is the current url and it exists, regardless of SSL issues
+								$button_url_to_try == $current_button_url &&
+								EEH_URL::remote_file_exists(
+									$button_url_to_try,
+									array(
+											'sslverify' => false,
+											'limit_response_size' => 4095,// we don't really care for a full response, but we do want headers at least. Lets just ask for a one block
+											)
+								)
+							)
+							||
+							(// this is NOT the current url and it exists with a working SSL cert
+								$button_url_to_try != $current_button_url &&
+								EEH_URL::remote_file_exists($button_url_to_try)
+							) ) {
+						if ($current_button_url != $button_url_to_try) {
+							$payment_method->save(array( 'PMD_button_url' => $button_url_to_try ));
+							EE_Error::add_attention(sprintf(__("Payment Method %s's button url was set to %s, because the old image either didnt exist or SSL was recently enabled.", "event_espresso"), $payment_method->name(), $button_url_to_try));
+						}
+						// this image exists. So if wasn't set before, now it is;
+						// or if it was already set, we have nothing to do
+						break;
+					}
+				}
+			} catch (EE_Error $e) {
+				$payment_method->set_active(false);
+			}
+		}
+	}
+
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _create_objects($rows = array())
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = array();
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 * @param EE_Transaction $transaction
+	 * @param string    $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, array( 'group_by' => 'PMD_type' )),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 *
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment methods returned.
+	 * It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id  Either the EE_Registration object or the id for the registration.
+	 * @return EE_Payment|null
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = array(
+			0 => array(
+				'Payment.Registration.REG_ID' => $registration_id,
+			),
+			'order_by' => array( 'Payment.PAY_ID' => 'DESC' )
+		);
+		return $this->get_one($query_params);
+	}
 }

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

Doc Comments +3 added lines, -3 removed lines

@@ -723,7 +723,7 @@ 
      * @since 4.9.74.p
      * @param $model
      * @param $results_so_far
-     * @param $protected
+     * @param boolean $protected
      * @return array results
      */
     protected function addProtectedProperty(EEM_Base $model, $results_so_far, $protected)
@@ -1262,7 +1262,7 @@ 
      * Also, this method's contents might be candidate for moving to Model_Data_Translator
      *
      * @param EEM_Base $model
-     * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
+     * @param array    $query_params  from $_GET parameter @see Read:handle_request_get_all
      * @return array model query params (@see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
      *                                    or FALSE to indicate that absolutely no results should be returned
      * @throws EE_Error
@@ -1519,7 +1519,7 @@ 
      *
      * @param EEM_Base $model
      * @param WP_REST_Request $request
-     * @param null $context
+     * @param string $context
      * @return array
      * @throws EE_Error
      */

Indentation +1554 added lines, -1554 removed lines

@@ -45,1558 +45,1558 @@
 {
 
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
-
-
-    /**
-     * Read constructor.
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(CalculatedModelFields $fields_calculator)
-    {
-        parent::__construct();
-        $this->fields_calculator = $fields_calculator;
-    }
-
-
-    /**
-     * Handles requests to get all (or a filtered subset) of entities for a particular model
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntitiesFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Prepares and returns schema for any OPTIONS request.
-     *
-     * @param string $version The API endpoint version being used.
-     * @param string $model_name Something like `Event` or `Registration`
-     * @return array
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public static function handleSchemaRequest($version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return array();
-            }
-            // get the model for this version
-            $model = $controller->getModelVersionInfo()->loadModel($model_name);
-            $model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
-            return $model_schema->getModelSchemaForRelations(
-                $controller->getModelVersionInfo()->relationSettings($model),
-                $controller->customizeSchemaForRestResponse(
-                    $model,
-                    $model_schema->getModelSchemaForFields(
-                        $controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
-                        $model_schema->getInitialSchemaStructure()
-                    )
-                )
-            );
-        } catch (Exception $e) {
-            return array();
-        }
-    }
-
-
-    /**
-     * This loops through each field in the given schema for the model and does the following:
-     * - add any extra fields that are REST API specific and related to existing fields.
-     * - transform default values into the correct format for a REST API response.
-     *
-     * @param EEM_Base $model
-     * @param array    $schema
-     * @return array  The final schema.
-     */
-    protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
-    {
-        foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
-            $schema = $this->translateDefaultsForRestResponse(
-                $field_name,
-                $field,
-                $this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
-     * response.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
-                    if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
-                            ModelDataTranslator::prepareFieldValueForJson(
-                                $field,
-                                $default_value,
-                                $this->getModelVersionInfo()->requestedVersion()
-                            );
-                    }
-                }
-            } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
-                    $field,
-                    $schema['properties'][ $field_name ]['default'],
-                    $this->getModelVersionInfo()->requestedVersion()
-                );
-            }
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Adds additional fields to the schema
-     * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
-     * needs to be added to the schema.
-     *
-     * @param                      $field_name
-     * @param EE_Model_Field_Base  $field
-     * @param array                $schema
-     * @return array
-     */
-    protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
-    {
-        if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
-            // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
-                esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
-                wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
-            );
-        }
-        return $schema;
-    }
-
-
-    /**
-     * Used to figure out the route from the request when a `WP_REST_Request` object is not available
-     *
-     * @return string
-     */
-    protected function getRouteFromRequest()
-    {
-        if (isset($GLOBALS['wp'])
-            && $GLOBALS['wp'] instanceof \WP
-            && isset($GLOBALS['wp']->query_vars['rest_route'])
-        ) {
-            return $GLOBALS['wp']->query_vars['rest_route'];
-        } else {
-            return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
-        }
-    }
-
-
-    /**
-     * Gets a single entity related to the model indicated in the path and its id
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
-    {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
-                return $controller->sendResponse(
-                    new WP_Error(
-                        'endpoint_parsing_error',
-                        sprintf(
-                            __(
-                                'There is no model for endpoint %s. Please contact event espresso support',
-                                'event_espresso'
-                            ),
-                            $model_name
-                        )
-                    )
-                );
-            }
-            return $controller->sendResponse(
-                $controller->getEntityFromModel(
-                    $controller->getModelVersionInfo()->loadModel($model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets all the related entities (or if its a belongs-to relation just the one)
-     * to the item with the given id
-     *
-     * @param WP_REST_Request $request
-     * @param string $version
-     * @param string $model_name
-     * @param string $related_model_name
-     * @return WP_REST_Response|WP_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public static function handleRequestGetRelated(
-        WP_REST_Request $request,
-        $version,
-        $model_name,
-        $related_model_name
-    ) {
-        $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
-        try {
-            $controller->setRequestedVersion($version);
-            $main_model = $controller->validateModel($model_name);
-            $controller->validateModel($related_model_name);
-            return $controller->sendResponse(
-                $controller->getEntitiesFromRelation(
-                    $request->get_param('id'),
-                    $main_model->related_settings_for($related_model_name),
-                    $request
-                )
-            );
-        } catch (Exception $e) {
-            return $controller->sendResponse($e);
-        }
-    }
-
-
-    /**
-     * Gets a collection for the given model and filters
-     *
-     * @param EEM_Base $model
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     */
-    public function getEntitiesFromModel($model, $request)
-    {
-        $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $model_name_plural),
-                sprintf(
-                    __('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-                ),
-                array('status' => 403)
-            );
-        }
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($model, $query_params);
-        }
-        /** @type array $results */
-        $results = $model->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_results[] =  $this->createEntityFromWpdbResult(
-                $model,
-                $result,
-                $request
-            );
-        }
-        return $nice_results;
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param array $primary_model_query_params query params for finding the item from which
-     *                                                            relations will be based
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request $request
-     * @return array
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     * @throws RestException
-     * @throws \EventEspresso\core\exceptions\ModelConfigurationException
-     */
-    protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        $model = $relation->get_this_model();
-        $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
-            $primary_model_query_params[0] = array();
-        }
-        // check if they can access the 1st model object
-        $primary_model_query_params = array(
-            0       => $primary_model_query_params[0],
-            'limit' => 1,
-        );
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
-                $primary_model_query_params
-            );
-        }
-        $restricted_query_params = $primary_model_query_params;
-        $restricted_query_params['caps'] = $context;
-        $restricted_query_params['limit'] = 1;
-        $this->setDebugInfo('main model query params', $restricted_query_params);
-        $this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
-        $primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        $primary_model_row = null;
-        if (is_array($primary_model_rows)) {
-            $primary_model_row = reset($primary_model_rows);
-        }
-        if (! (
-            Capabilities::currentUserHasPartialAccessTo($related_model, $context)
-            && $primary_model_row
-        )
-        ) {
-            if ($relation instanceof EE_Belongs_To_Relation) {
-                $related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
-            } else {
-                $related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
-                    $related_model->get_this_model_name()
-                );
-            }
-            throw new RestException(
-                sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
-                sprintf(
-                    __(
-                        'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
-                        'event_espresso'
-                    ),
-                    $related_model_name_maybe_plural,
-                    $relation->get_this_model()->get_this_model_name(),
-                    implode(
-                        ',',
-                        array_keys(
-                            Capabilities::getMissingPermissions($related_model, $context)
-                        )
-                    )
-                ),
-                array('status' => 403)
-            );
-        }
-
-        $this->checkPassword(
-            $model,
-            $primary_model_row,
-            $restricted_query_params,
-            $request
-        );
-        $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
-        foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
-                              . '.'
-                              . $where_condition_key ] = $where_condition_value;
-        }
-        $query_params['default_where_conditions'] = 'none';
-        $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
-            $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
-        }
-        /** @type array $results */
-        $results = $relation->get_other_model()->get_all_wpdb_results($query_params);
-        $nice_results = array();
-        foreach ($results as $result) {
-            $nice_result = $this->createEntityFromWpdbResult(
-                $relation->get_other_model(),
-                $result,
-                $request
-            );
-            if ($relation instanceof \EE_HABTM_Relation) {
-                // put the unusual stuff (properties from the HABTM relation) first, and make sure
-                // if there are conflicts we prefer the properties from the main model
-                $join_model_result = $this->createEntityFromWpdbResult(
-                    $relation->get_join_model(),
-                    $result,
-                    $request
-                );
-                $joined_result = array_merge($nice_result, $join_model_result);
-                // but keep the meta stuff from the main model
-                if (isset($nice_result['meta'])) {
-                    $joined_result['meta'] = $nice_result['meta'];
-                }
-                $nice_result = $joined_result;
-            }
-            $nice_results[] = $nice_result;
-        }
-        if ($relation instanceof EE_Belongs_To_Relation) {
-            return array_shift($nice_results);
-        } else {
-            return $nice_results;
-        }
-    }
-
-
-    /**
-     * Gets the collection for given relation object
-     * The same as Read::get_entities_from_model(), except if the relation
-     * is a HABTM relation, in which case it merges any non-foreign-key fields from
-     * the join-model-object into the results
-     *
-     * @param string                  $id the ID of the thing we are fetching related stuff from
-     * @param \EE_Model_Relation_Base $relation
-     * @param WP_REST_Request         $request
-     * @return array
-     * @throws EE_Error
-     */
-    public function getEntitiesFromRelation($id, $relation, $request)
-    {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                    // @codingStandardsIgnoreStart
-                        'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    ),
-                    $relation->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        // can we edit that main item?
-        // if not, show nothing but an error
-        // otherwise, please proceed
-        return $this->getEntitiesFromRelationUsingModelQueryParams(
-            array(
-                array(
-                    $relation->get_this_model()->primary_key_name() => $id,
-                ),
-            ),
-            $relation,
-            $request
-        );
-    }
-
-
-    /**
-     * Sets the headers that are based on the model and query params,
-     * like the total records. This should only be called on the original request
-     * from the client, not on subsequent internal
-     *
-     * @param EEM_Base $model
-     * @param array    $query_params
-     * @return void
-     */
-    protected function setHeadersFromQueryParams($model, $query_params)
-    {
-        $this->setDebugInfo('model query params', $query_params);
-        $this->setDebugInfo(
-            'missing caps',
-            Capabilities::getMissingPermissionsString($model, $query_params['caps'])
-        );
-        // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
-            $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (is_array($query_params['limit'])) {
-            $limit_parts = $query_params['limit'];
-        } else {
-            $limit_parts = explode(',', $query_params['limit']);
-            if (count($limit_parts) == 1) {
-                $limit_parts = array(0, $limit_parts[0]);
-            }
-        }
-        // remove the group by and having parts of the query, as those will
-        // make the sql query return an array of values, instead of just a single value
-        unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
-        $count = $model->count($query_params, null, true);
-        $pages = $count / $limit_parts[1];
-        $this->setResponseHeader('Total', $count, false);
-        $this->setResponseHeader('PageSize', $limit_parts[1], false);
-        $this->setResponseHeader('TotalPages', ceil($pages), false);
-    }
-
-
-    /**
-     * Changes database results into REST API entities
-     *
-     * @param EEM_Base $model
-     * @param array $db_row like results from $wpdb->get_results()
-     * @param WP_REST_Request $rest_request
-     * @param string $deprecated no longer used
-     * @return array ready for being converted into json for sending to client
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     */
-    public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
-    {
-        if (! $rest_request instanceof WP_REST_Request) {
-            // ok so this was called in the old style, where the 3rd arg was
-            // $include, and the 4th arg was $context
-            // now setup the request just to avoid fatal errors, although we won't be able
-            // to truly make use of it because it's kinda devoid of info
-            $rest_request = new WP_REST_Request();
-            $rest_request->set_param('include', $rest_request);
-            $rest_request->set_param('caps', $deprecated);
-        }
-        if ($rest_request->get_param('caps') == null) {
-            $rest_request->set_param('caps', EEM_Base::caps_read);
-        }
-        $current_user_full_access_to_entity = $model->currentUserCan(
-            EEM_Base::caps_read_admin,
-            $model->deduce_fields_n_values_from_cols_n_values($db_row)
-        );
-        $entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
-        $entity_array = $this->addExtraFields($model, $db_row, $entity_array);
-        $entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
-        // when it's a regular read request for a model with a password and the password wasn't provided
-        // remove the password protected fields
-        $has_protected_fields = false;
-        try {
-            $this->checkPassword(
-                $model,
-                $db_row,
-                $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                ),
-                $rest_request
-            );
-        } catch (RestPasswordRequiredException $e) {
-            if ($model->hasPassword()) {
-                // just remove protected fields
-                $has_protected_fields = true;
-                $entity_array = Capabilities::filterOutPasswordProtectedFields(
-                    $entity_array,
-                    $model,
-                    $this->getModelVersionInfo()
-                );
-            } else {
-                // that's a problem. None of this should be accessible if no password was provided
-                throw $e;
-            }
-        }
-
-        $entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request, $has_protected_fields);
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        // add an empty protected property for now. If it's still around after we remove everything the request didn't
-        // want, we'll populate it then. k?
-        $entity_array['_protected'] = array();
-        // remove any properties the request didn't want. This way _protected won't bother mentioning them
-        $entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
-        $entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row, $has_protected_fields);
-        // if they still wanted the _protected property, add it.
-        if (isset($entity_array['_protected'])) {
-            $entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
-        }
-        $entity_array = apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            $entity_array,
-            $model,
-            $rest_request->get_param('caps'),
-            $rest_request,
-            $this
-        );
-        if (! $current_user_full_access_to_entity) {
-            $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
-                $entity_array,
-                $model,
-                $rest_request->get_param('caps'),
-                $this->getModelVersionInfo()
-            );
-        } else {
-            $result_without_inaccessible_fields = $entity_array;
-        }
-        $this->setDebugInfo(
-            'inaccessible fields',
-            array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
-        );
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_return',
-            $result_without_inaccessible_fields,
-            $model,
-            $rest_request->get_param('caps')
-        );
-    }
-
-    /**
-     * Returns an array describing which fields can be protected, and which actually were removed this request
-     * @since 4.9.74.p
-     * @param $model
-     * @param $results_so_far
-     * @param $protected
-     * @return array results
-     */
-    protected function addProtectedProperty(EEM_Base $model, $results_so_far, $protected)
-    {
-        if (! $model->hasPassword() || ! $protected) {
-            return $results_so_far;
-        }
-        $password_field = $model->getPasswordField();
-        $all_protected = array_merge(
-            array($password_field->get_name()),
-            $password_field->protectedFields()
-        );
-        $fields_included = array_keys($results_so_far);
-        $fields_included = array_intersect(
-            $all_protected,
-            $fields_included
-        );
-        foreach ($fields_included as $field_name) {
-            $results_so_far['_protected'][] = $field_name ;
-        }
-        return $results_so_far;
-    }
-
-    /**
-     * Creates a REST entity array (JSON object we're going to return in the response, but
-     * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
-     * from $wpdb->get_row( $sql, ARRAY_A)
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @return array entity mostly ready for converting to JSON and sending in the response
-     */
-    protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
-    {
-        $result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
-        $result = array_intersect_key(
-            $result,
-            $this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
-        );
-        // if this is a CPT, we need to set the global $post to it,
-        // otherwise shortcodes etc won't work properly while rendering it
-        if ($model instanceof \EEM_CPT_Base) {
-            $do_chevy_shuffle = true;
-        } else {
-            $do_chevy_shuffle = false;
-        }
-        if ($do_chevy_shuffle) {
-            global $post;
-            $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
-                // well that's weird, because $result is what we JUST fetched from the database
-                throw new RestException(
-                    'error_fetching_post_from_database_results',
-                    esc_html__(
-                        'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
-                        'event_espresso'
-                    )
-                );
-            }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
-            $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
-                $model_object_classname,
-                $result,
-                false,
-                false
-            );
-        }
-        foreach ($result as $field_name => $field_value) {
-            $field_obj = $model->field_settings_for($field_name);
-            if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($this->isSubclassOfOne(
-                $field_obj,
-                $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
-            )
-            ) {
-                $result[ $field_name ] = array(
-                    'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
-                    'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
-                );
-            } elseif ($field_obj instanceof \EE_Datetime_Field) {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value);
-                // if the value is null, but we're not supposed to permit null, then set to the field's default
-                if (is_null($field_value)) {
-                    $field_value = $field_obj->getDefaultDateTimeObj();
-                }
-                if (is_null($field_value)) {
-                    $gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                } else {
-                    $timezone = $field_value->getTimezone();
-                    EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
-                    $gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                    EEH_DTT_Helper::setTimezone($field_value, $timezone);
-                    $local_date = ModelDataTranslator::prepareFieldValuesForJson(
-                        $field_obj,
-                        $field_value,
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
-            } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
-            }
-        }
-        if ($do_chevy_shuffle) {
-            $post = $old_post;
-        }
-        return $result;
-    }
-
-
-    /**
-     * Takes a value all the way from the DB representation, to the model object's representation, to the
-     * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
-     * representation using $field_obj->prepare_for_set_from_db())
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $value  as it's stored on a model object
-     * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
-     * @return mixed
-     * @throws ObjectDetectedException if $value contains a PHP object
-     */
-    protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
-    {
-        $value = $field_obj->prepare_for_set_from_db($value);
-        switch ($format) {
-            case 'pretty':
-                $value = $field_obj->prepare_for_pretty_echoing($value);
-                break;
-            case 'normal':
-            default:
-                $value = $field_obj->prepare_for_get($value);
-                break;
-        }
-        return ModelDataTranslator::prepareFieldValuesForJson(
-            $field_obj,
-            $value,
-            $this->getModelVersionInfo()->requestedVersion()
-        );
-    }
-
-
-    /**
-     * Adds a few extra fields to the entity response
-     *
-     * @param EEM_Base $model
-     * @param array    $db_row
-     * @param array    $entity_array
-     * @return array modified entity
-     */
-    protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
-    {
-        if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Gets links we want to add to the response
-     *
-     * @global \WP_REST_Server $wp_rest_server
-     * @param EEM_Base         $model
-     * @param array            $db_row
-     * @param array            $entity_array
-     * @return array the _links item in the entity
-     */
-    protected function getEntityLinks($model, $db_row, $entity_array)
-    {
-        // add basic links
-        $links = array();
-        if ($model->has_primary_key_field()) {
-            $links['self'] = array(
-                array(
-                    'href' => $this->getVersionedLinkTo(
-                        EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                        . '/'
-                        . $entity_array[ $model->primary_key_name() ]
-                    ),
-                ),
-            );
-        }
-        $links['collection'] = array(
-            array(
-                'href' => $this->getVersionedLinkTo(
-                    EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                ),
-            ),
-        );
-        // add links to related models
-        if ($model->has_primary_key_field()) {
-            foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
-                $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
-                    array(
-                        'href'   => $this->getVersionedLinkTo(
-                            EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
-                            . '/'
-                            . $entity_array[ $model->primary_key_name() ]
-                            . '/'
-                            . $related_model_part
-                        ),
-                        'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
-                    ),
-                );
-            }
-        }
-        return $links;
-    }
-
-
-    /**
-     * Adds the included models indicated in the request to the entity provided
-     *
-     * @param EEM_Base $model
-     * @param WP_REST_Request $rest_request
-     * @param array $entity_array
-     * @param array $db_row
-     * @param boolean $included_items_protected if the original item is password protected, don't include any related models.
-     * @return array the modified entity
-     * @throws RestException
-     */
-    protected function includeRequestedModels(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array,
-        $db_row = array(),
-        $included_items_protected = false
-    ) {
-        // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
-            $db_row = $entity_array;
-        }
-        $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
-        foreach ($relation_settings as $relation_name => $relation_obj) {
-            $related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('include'),
-                $relation_name
-            );
-            $related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
-                $rest_request->get_param('calculate'),
-                $relation_name
-            );
-            // did they specify they wanted to include a related model, or
-            // specific fields from a related model?
-            // or did they specify to calculate a field from a related model?
-            if ($related_fields_to_include || $related_fields_to_calculate) {
-                // if so, we should include at least some part of the related model
-                $pretend_related_request = new WP_REST_Request();
-                $pretend_related_request->set_query_params(
-                    array(
-                        'caps'      => $rest_request->get_param('caps'),
-                        'include'   => $related_fields_to_include,
-                        'calculate' => $related_fields_to_calculate,
-                        'password' => $rest_request->get_param('password')
-                    )
-                );
-                $pretend_related_request->add_header('no_rest_headers', true);
-                $primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
-                    $model->get_index_primary_key_string(
-                        $model->deduce_fields_n_values_from_cols_n_values($db_row)
-                    )
-                );
-                if (! $included_items_protected) {
-                    try {
-                        $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
-                            $primary_model_query_params,
-                            $relation_obj,
-                            $pretend_related_request
-                        );
-                    } catch (RestException $e) {
-                        $related_results = null;
-                    }
-                } else {
-                    // they're protected, hide them.
-                    $related_results = null;
-                    $entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
-                }
-                if ($related_results instanceof WP_Error || $related_results === null) {
-                    $related_results = $relation_obj instanceof EE_Belongs_To_Relation ? null : array();
-                }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
-            }
-        }
-        return $entity_array;
-    }
-
-    /**
-     * If the user has requested only specific properties (including meta properties like _links or _protected)
-     * remove everything else.
-     * @since 4.9.74.p
-     * @param EEM_Base $model
-     * @param WP_REST_Request $rest_request
-     * @param $entity_array
-     * @return array
-     * @throws EE_Error
-     */
-    protected function includeOnlyRequestedProperties(
-        EEM_Base $model,
-        WP_REST_Request $rest_request,
-        $entity_array
-    ) {
-
-        $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
-        $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
-        // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
-            && ! empty($includes_for_this_model)
-        ) {
-            if ($model->has_primary_key_field()) {
-                // always include the primary key. ya just gotta know that at least
-                $includes_for_this_model[] = $model->primary_key_name();
-            }
-            if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
-                $includes_for_this_model[] = '_calculated_fields';
-            }
-            $entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
-        }
-        return $entity_array;
-    }
-
-
-    /**
-     * Returns a new array with all the names of models removed. Eg
-     * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
-     *
-     * @param array $arr
-     * @return array
-     */
-    private function removeModelNamesFromArray($arr)
-    {
-        return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
-    }
-
-
-    /**
-     * Gets the calculated fields for the response
-     *
-     * @param EEM_Base        $model
-     * @param array           $wpdb_row
-     * @param WP_REST_Request $rest_request
-     * @param boolean $row_is_protected whether this row is password protected or not
-     * @return \stdClass the _calculations item in the entity
-     * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
-     * did, let's know about it ASAP, so let the exception bubble up)
-     */
-    protected function getEntityCalculations($model, $wpdb_row, $rest_request, $row_is_protected = false)
-    {
-        $calculated_fields = $this->explodeAndGetItemsPrefixedWith(
-            $rest_request->get_param('calculate'),
-            ''
-        );
-        // note: setting calculate=* doesn't do anything
-        $calculated_fields_to_return = new \stdClass();
-        $protected_fields = array();
-        foreach ($calculated_fields as $field_to_calculate) {
-            try {
-                // it's password protected, so they shouldn't be able to read this. Remove the value
-                $schema = $this->fields_calculator->getJsonSchemaForModel($model);
-                if ($row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']) {
-                    $calculated_value = null;
-                    $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
-                            case 'boolean':
-                                $calculated_value = false;
-                                break;
-                            case 'integer':
-                                $calculated_value = 0;
-                                break;
-                            case 'string':
-                                $calculated_value = '';
-                                break;
-                            case 'array':
-                                $calculated_value = array();
-                                break;
-                            case 'object':
-                                $calculated_value = new stdClass();
-                                break;
-                        }
-                    }
-                } else {
-                    $calculated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        null,
-                        $this->fields_calculator->retrieveCalculatedFieldValue(
-                            $model,
-                            $field_to_calculate,
-                            $wpdb_row,
-                            $rest_request,
-                            $this
-                        ),
-                        $this->getModelVersionInfo()->requestedVersion()
-                    );
-                }
-                $calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
-            } catch (RestException $e) {
-                // if we don't have permission to read it, just leave it out. but let devs know about the problem
-                $this->setResponseHeader(
-                    'Notices-Field-Calculation-Errors['
-                    . $e->getStringCode()
-                    . ']['
-                    . $model->get_this_model_name()
-                    . ']['
-                    . $field_to_calculate
-                    . ']',
-                    $e->getMessage(),
-                    true
-                );
-            }
-        }
-        $calculated_fields_to_return->_protected = $protected_fields;
-        return $calculated_fields_to_return;
-    }
-
-
-    /**
-     * Gets the full URL to the resource, taking the requested version into account
-     *
-     * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
-     * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
-     */
-    public function getVersionedLinkTo($link_part_after_version_and_slash)
-    {
-        return rest_url(
-            EED_Core_Rest_Api::get_versioned_route_to(
-                $link_part_after_version_and_slash,
-                $this->getModelVersionInfo()->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets the correct lowercase name for the relation in the API according
-     * to the relation's type
-     *
-     * @param string                  $relation_name
-     * @param \EE_Model_Relation_Base $relation_obj
-     * @return string
-     */
-    public static function getRelatedEntityName($relation_name, $relation_obj)
-    {
-        if ($relation_obj instanceof EE_Belongs_To_Relation) {
-            return strtolower($relation_name);
-        } else {
-            return EEH_Inflector::pluralize_and_lower($relation_name);
-        }
-    }
-
-
-    /**
-     * Gets the one model object with the specified id for the specified model
-     *
-     * @param EEM_Base        $model
-     * @param WP_REST_Request $request
-     * @return array
-     */
-    public function getEntityFromModel($model, $request)
-    {
-        $context = $this->validateContext($request->get_param('caps'));
-        return $this->getOneOrReportPermissionError($model, $request, $context);
-    }
-
-
-    /**
-     * If a context is provided which isn't valid, maybe it was added in a future
-     * version so just treat it as a default read
-     *
-     * @param string $context
-     * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
-     */
-    public function validateContext($context)
-    {
-        if (! $context) {
-            $context = EEM_Base::caps_read;
-        }
-        $valid_contexts = EEM_Base::valid_cap_contexts();
-        if (in_array($context, $valid_contexts)) {
-            return $context;
-        } else {
-            return EEM_Base::caps_read;
-        }
-    }
-
-
-    /**
-     * Verifies the passed in value is an allowable default where conditions value.
-     *
-     * @param $default_query_params
-     * @return string
-     */
-    public function validateDefaultQueryParams($default_query_params)
-    {
-        $valid_default_where_conditions_for_api_calls = array(
-            EEM_Base::default_where_conditions_all,
-            EEM_Base::default_where_conditions_minimum_all,
-            EEM_Base::default_where_conditions_minimum_others,
-        );
-        if (! $default_query_params) {
-            $default_query_params = EEM_Base::default_where_conditions_all;
-        }
-        if (in_array(
-            $default_query_params,
-            $valid_default_where_conditions_for_api_calls,
-            true
-        )) {
-            return $default_query_params;
-        } else {
-            return EEM_Base::default_where_conditions_all;
-        }
-    }
-
-
-    /**
-     * Translates API filter get parameter into model query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
-     * Note: right now the query parameter keys for fields (and related fields)
-     * can be left as-is, but it's quite possible this will change someday.
-     * Also, this method's contents might be candidate for moving to Model_Data_Translator
-     *
-     * @param EEM_Base $model
-     * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
-     * @return array model query params (@see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
-     *                                    or FALSE to indicate that absolutely no results should be returned
-     * @throws EE_Error
-     * @throws RestException
-     */
-    public function createModelQueryParams($model, $query_params)
-    {
-        $model_query_params = array();
-        if (isset($query_params['where'])) {
-            $model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['where'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order_by'])) {
-            $order_by = $query_params['order_by'];
-        } elseif (isset($query_params['orderby'])) {
-            $order_by = $query_params['orderby'];
-        } else {
-            $order_by = null;
-        }
-        if ($order_by !== null) {
-            if (is_array($order_by)) {
-                $order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
-            } else {
-                // it's a single item
-                $order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
-            }
-            $model_query_params['order_by'] = $order_by;
-        }
-        if (isset($query_params['group_by'])) {
-            $group_by = $query_params['group_by'];
-        } elseif (isset($query_params['groupby'])) {
-            $group_by = $query_params['groupby'];
-        } else {
-            $group_by = array_keys($model->get_combined_primary_key_fields());
-        }
-        // make sure they're all real names
-        if (is_array($group_by)) {
-            $group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
-        }
-        if ($group_by !== null) {
-            $model_query_params['group_by'] = $group_by;
-        }
-        if (isset($query_params['having'])) {
-            $model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $query_params['having'],
-                $model,
-                $this->getModelVersionInfo()->requestedVersion()
-            );
-        }
-        if (isset($query_params['order'])) {
-            $model_query_params['order'] = $query_params['order'];
-        }
-        if (isset($query_params['mine'])) {
-            $model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
-        }
-        if (isset($query_params['limit'])) {
-            // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
-                $limit_array = explode(',', (string) $query_params['limit']);
-            } else {
-                $limit_array = $query_params['limit'];
-            }
-            $sanitized_limit = array();
-            foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
-                    throw new EE_Error(
-                        sprintf(
-                            __(
-                            // @codingStandardsIgnoreStart
-                                'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
-                                // @codingStandardsIgnoreEnd
-                                'event_espresso'
-                            ),
-                            wp_json_encode($query_params['limit'])
-                        )
-                    );
-                }
-                $sanitized_limit[] = (int) $limit_part;
-            }
-            $model_query_params['limit'] = implode(',', $sanitized_limit);
-        } else {
-            $model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
-        }
-        if (isset($query_params['caps'])) {
-            $model_query_params['caps'] = $this->validateContext($query_params['caps']);
-        } else {
-            $model_query_params['caps'] = EEM_Base::caps_read;
-        }
-        if (isset($query_params['default_where_conditions'])) {
-            $model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
-                $query_params['default_where_conditions']
-            );
-        }
-        // if this is a model protected by a password on another model, exclude the password protected
-        // entities by default. But if they passed in a password, try to show them all. If the password is wrong,
-        // though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
-        if (! $model->hasPassword()
-            && $model->restrictedByRelatedModelPassword()
-            && $model_query_params['caps'] === EEM_Base::caps_read) {
-            if (empty($query_params['password'])) {
-                $model_query_params['exclude_protected'] = true;
-            }
-        }
-
-        return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
-    }
-
-
-    /**
-     * Changes the REST-style query params for use in the models
-     *
-     * @deprecated
-     * @param EEM_Base $model
-     * @param array    $query_params sub-array from @see EEM_Base::get_all()
-     * @return array
-     */
-    public function prepareRestQueryParamsKeyForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
-     * @param $model
-     * @param $query_params
-     * @return array
-     */
-    public function prepareRestQueryParamsValuesForModels($model, $query_params)
-    {
-        $model_ready_query_params = array();
-        foreach ($query_params as $key => $value) {
-            if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
-            } else {
-                $model_ready_query_params[ $key ] = $value;
-            }
-        }
-        return $model_ready_query_params;
-    }
-
-
-    /**
-     * Explodes the string on commas, and only returns items with $prefix followed by a period.
-     * If no prefix is specified, returns items with no period.
-     *
-     * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
-     * @param string       $prefix            "Event" or "foobar"
-     * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
-     *                                        we only return strings starting with that and a period; if no prefix was
-     *                                        specified we return all items containing NO periods
-     */
-    public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
-    {
-        if (is_string($string_to_explode)) {
-            $exploded_contents = explode(',', $string_to_explode);
-        } elseif (is_array($string_to_explode)) {
-            $exploded_contents = $string_to_explode;
-        } else {
-            $exploded_contents = array();
-        }
-        // if the string was empty, we want an empty array
-        $exploded_contents = array_filter($exploded_contents);
-        $contents_with_prefix = array();
-        foreach ($exploded_contents as $item) {
-            $item = trim($item);
-            // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
-                // does this item have a period?
-                if (strpos($item, '.') === false) {
-                    // if not, then its what we're looking for
-                    $contents_with_prefix[] = $item;
-                }
-            } elseif (strpos($item, $prefix . '.') === 0) {
-                // this item has the prefix and a period, grab it
-                $contents_with_prefix[] = substr(
-                    $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
-                );
-            } elseif ($item === $prefix) {
-                // this item is JUST the prefix
-                // so let's grab everything after, which is a blank string
-                $contents_with_prefix[] = '';
-            }
-        }
-        return $contents_with_prefix;
-    }
-
-
-    /**
-     * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
-     * Deprecated because its return values were really quite confusing- sometimes it returned
-     * an empty array (when the include string was blank or '*') or sometimes it returned
-     * array('*') (when you provided a model and a model of that kind was found).
-     * Parses the $include_string so we fetch all the field names relating to THIS model
-     * (ie have NO period in them), or for the provided model (ie start with the model
-     * name and then a period).
-     * @param string $include_string @see Read:handle_request_get_all
-     * @param string $model_name
-     * @return array of fields for this model. If $model_name is provided, then
-     *                               the fields for that model, with the model's name removed from each.
-     *                               If $include_string was blank or '*' returns an empty array
-     */
-    public function extractIncludesForThisModel($include_string, $model_name = null)
-    {
-        if (is_array($include_string)) {
-            $include_string = implode(',', $include_string);
-        }
-        if ($include_string === '*' || $include_string === '') {
-            return array();
-        }
-        $includes = explode(',', $include_string);
-        $extracted_fields_to_include = array();
-        if ($model_name) {
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
-                    // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
-                    $extracted_fields_to_include[] = $field_sans_model_name;
-                } elseif ($field_to_include == $model_name) {
-                    $extracted_fields_to_include[] = '*';
-                }
-            }
-        } else {
-            // look for ones with no period
-            foreach ($includes as $field_to_include) {
-                $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, '.') === false
-                    && ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
-                ) {
-                    $extracted_fields_to_include[] = $field_to_include;
-                }
-            }
-        }
-        return $extracted_fields_to_include;
-    }
-
-
-    /**
-     * Gets the single item using the model according to the request in the context given, otherwise
-     * returns that it's inaccessible to the current user
-     *
-     * @param EEM_Base $model
-     * @param WP_REST_Request $request
-     * @param null $context
-     * @return array
-     * @throws EE_Error
-     */
-    public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
-    {
-        $query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
-        if ($model instanceof EEM_Soft_Delete_Base) {
-            $query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
-        }
-        $restricted_query_params = $query_params;
-        $restricted_query_params['caps'] = $context;
-        $this->setDebugInfo('model query params', $restricted_query_params);
-        $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
-            return $this->createEntityFromWpdbResult(
-                $model,
-                reset($model_rows),
-                $request
-            );
-        } else {
-            // ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
-            $lowercase_model_name = strtolower($model->get_this_model_name());
-            if ($model->exists($query_params)) {
-                // you got shafted- it existed but we didn't want to tell you!
-                throw new RestException(
-                    'rest_user_cannot_' . $context,
-                    sprintf(
-                        __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
-                        $context,
-                        $lowercase_model_name,
-                        Capabilities::getMissingPermissionsString(
-                            $model,
-                            $context
-                        )
-                    ),
-                    array('status' => 403)
-                );
-            } else {
-                // it's not you. It just doesn't exist
-                throw new RestException(
-                    sprintf('rest_%s_invalid_id', $lowercase_model_name),
-                    sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
-                    array('status' => 404)
-                );
-            }
-        }
-    }
-
-    /**
-     * Checks that if this content requires a password to be read, that it's been provided and is correct.
-     * @since 4.9.74.p
-     * @param EEM_Base $model
-     * @param $model_row
-     * @param $query_params Adds 'default_where_conditions' => 'minimum' to ensure we don't confuse trashed with
-     *                      password protected.
-     * @param WP_REST_Request $request
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws RestPasswordRequiredException
-     * @throws RestPasswordIncorrectException
-     * @throws \EventEspresso\core\exceptions\ModelConfigurationException
-     * @throws ReflectionException
-     */
-    protected function checkPassword(EEM_Base $model, $model_row, $query_params, WP_REST_Request $request)
-    {
-        $query_params['default_where_conditions'] = 'minimum';
-        // stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
-        // or you don't.
-        $request_caps = $request->get_param('caps');
-        if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
-            return;
-        }
-        // if this entity requires a password, they better give it and it better be right!
-        if ($model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== '') {
-            if (empty($request['password'])) {
-                throw new RestPasswordRequiredException();
-            } elseif (!hash_equals(
-                $model_row[ $model->getPasswordField()->get_qualified_column() ],
-                $request['password']
-            )) {
-                throw new RestPasswordIncorrectException();
-            }
-        } // wait! maybe this content is password protected
-        elseif ($model->restrictedByRelatedModelPassword()
-            && $request->get_param('caps') === EEM_Base::caps_read) {
-            $password_supplied = $request->get_param('password');
-            if (empty($password_supplied)) {
-                $query_params['exclude_protected'] = true;
-                if (!$model->exists($query_params)) {
-                    throw new RestPasswordRequiredException();
-                }
-            } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (!$model->exists($query_params)) {
-                    throw new RestPasswordIncorrectException();
-                }
-            }
-        }
-    }
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
+
+
+	/**
+	 * Read constructor.
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(CalculatedModelFields $fields_calculator)
+	{
+		parent::__construct();
+		$this->fields_calculator = $fields_calculator;
+	}
+
+
+	/**
+	 * Handles requests to get all (or a filtered subset) of entities for a particular model
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleRequestGetAll(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntitiesFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Prepares and returns schema for any OPTIONS request.
+	 *
+	 * @param string $version The API endpoint version being used.
+	 * @param string $model_name Something like `Event` or `Registration`
+	 * @return array
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public static function handleSchemaRequest($version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return array();
+			}
+			// get the model for this version
+			$model = $controller->getModelVersionInfo()->loadModel($model_name);
+			$model_schema = new JsonModelSchema($model, LoaderFactory::getLoader()->getShared('EventEspresso\core\libraries\rest_api\CalculatedModelFields'));
+			return $model_schema->getModelSchemaForRelations(
+				$controller->getModelVersionInfo()->relationSettings($model),
+				$controller->customizeSchemaForRestResponse(
+					$model,
+					$model_schema->getModelSchemaForFields(
+						$controller->getModelVersionInfo()->fieldsOnModelInThisVersion($model),
+						$model_schema->getInitialSchemaStructure()
+					)
+				)
+			);
+		} catch (Exception $e) {
+			return array();
+		}
+	}
+
+
+	/**
+	 * This loops through each field in the given schema for the model and does the following:
+	 * - add any extra fields that are REST API specific and related to existing fields.
+	 * - transform default values into the correct format for a REST API response.
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $schema
+	 * @return array  The final schema.
+	 */
+	protected function customizeSchemaForRestResponse(EEM_Base $model, array $schema)
+	{
+		foreach ($this->getModelVersionInfo()->fieldsOnModelInThisVersion($model) as $field_name => $field) {
+			$schema = $this->translateDefaultsForRestResponse(
+				$field_name,
+				$field,
+				$this->maybeAddExtraFieldsToSchema($field_name, $field, $schema)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * This is used to ensure that the 'default' value set in the schema response is formatted correctly for the REST
+	 * response.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if (isset($schema['properties'][ $field_name ]['default'])) {
+			if (is_array($schema['properties'][ $field_name ]['default'])) {
+				foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+					if ($default_key === 'raw') {
+						$schema['properties'][ $field_name ]['default'][ $default_key ] =
+							ModelDataTranslator::prepareFieldValueForJson(
+								$field,
+								$default_value,
+								$this->getModelVersionInfo()->requestedVersion()
+							);
+					}
+				}
+			} else {
+				$schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+					$field,
+					$schema['properties'][ $field_name ]['default'],
+					$this->getModelVersionInfo()->requestedVersion()
+				);
+			}
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Adds additional fields to the schema
+	 * The REST API returns a GMT value field for each datetime field in the resource.  Thus the description about this
+	 * needs to be added to the schema.
+	 *
+	 * @param                      $field_name
+	 * @param EE_Model_Field_Base  $field
+	 * @param array                $schema
+	 * @return array
+	 */
+	protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
+	{
+		if ($field instanceof EE_Datetime_Field) {
+			$schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+			// modify the description
+			$schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+				esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
+				wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
+			);
+		}
+		return $schema;
+	}
+
+
+	/**
+	 * Used to figure out the route from the request when a `WP_REST_Request` object is not available
+	 *
+	 * @return string
+	 */
+	protected function getRouteFromRequest()
+	{
+		if (isset($GLOBALS['wp'])
+			&& $GLOBALS['wp'] instanceof \WP
+			&& isset($GLOBALS['wp']->query_vars['rest_route'])
+		) {
+			return $GLOBALS['wp']->query_vars['rest_route'];
+		} else {
+			return isset($_SERVER['PATH_INFO']) ? $_SERVER['PATH_INFO'] : '/';
+		}
+	}
+
+
+	/**
+	 * Gets a single entity related to the model indicated in the path and its id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetOne(WP_REST_Request $request, $version, $model_name)
+	{
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+				return $controller->sendResponse(
+					new WP_Error(
+						'endpoint_parsing_error',
+						sprintf(
+							__(
+								'There is no model for endpoint %s. Please contact event espresso support',
+								'event_espresso'
+							),
+							$model_name
+						)
+					)
+				);
+			}
+			return $controller->sendResponse(
+				$controller->getEntityFromModel(
+					$controller->getModelVersionInfo()->loadModel($model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets all the related entities (or if its a belongs-to relation just the one)
+	 * to the item with the given id
+	 *
+	 * @param WP_REST_Request $request
+	 * @param string $version
+	 * @param string $model_name
+	 * @param string $related_model_name
+	 * @return WP_REST_Response|WP_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public static function handleRequestGetRelated(
+		WP_REST_Request $request,
+		$version,
+		$model_name,
+		$related_model_name
+	) {
+		$controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
+		try {
+			$controller->setRequestedVersion($version);
+			$main_model = $controller->validateModel($model_name);
+			$controller->validateModel($related_model_name);
+			return $controller->sendResponse(
+				$controller->getEntitiesFromRelation(
+					$request->get_param('id'),
+					$main_model->related_settings_for($related_model_name),
+					$request
+				)
+			);
+		} catch (Exception $e) {
+			return $controller->sendResponse($e);
+		}
+	}
+
+
+	/**
+	 * Gets a collection for the given model and filters
+	 *
+	 * @param EEM_Base $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 */
+	public function getEntitiesFromModel($model, $request)
+	{
+		$query_params = $this->createModelQueryParams($model, $request->get_params());
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $model_name_plural),
+				sprintf(
+					__('Sorry, you are not allowed to list %1$s. Missing permissions: %2$s', 'event_espresso'),
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+				),
+				array('status' => 403)
+			);
+		}
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($model, $query_params);
+		}
+		/** @type array $results */
+		$results = $model->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_results[] =  $this->createEntityFromWpdbResult(
+				$model,
+				$result,
+				$request
+			);
+		}
+		return $nice_results;
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param array $primary_model_query_params query params for finding the item from which
+	 *                                                            relations will be based
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request $request
+	 * @return array
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 * @throws RestException
+	 * @throws \EventEspresso\core\exceptions\ModelConfigurationException
+	 */
+	protected function getEntitiesFromRelationUsingModelQueryParams($primary_model_query_params, $relation, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		$model = $relation->get_this_model();
+		$related_model = $relation->get_other_model();
+		if (! isset($primary_model_query_params[0])) {
+			$primary_model_query_params[0] = array();
+		}
+		// check if they can access the 1st model object
+		$primary_model_query_params = array(
+			0       => $primary_model_query_params[0],
+			'limit' => 1,
+		);
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$primary_model_query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included(
+				$primary_model_query_params
+			);
+		}
+		$restricted_query_params = $primary_model_query_params;
+		$restricted_query_params['caps'] = $context;
+		$restricted_query_params['limit'] = 1;
+		$this->setDebugInfo('main model query params', $restricted_query_params);
+		$this->setDebugInfo('missing caps', Capabilities::getMissingPermissionsString($related_model, $context));
+		$primary_model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		$primary_model_row = null;
+		if (is_array($primary_model_rows)) {
+			$primary_model_row = reset($primary_model_rows);
+		}
+		if (! (
+			Capabilities::currentUserHasPartialAccessTo($related_model, $context)
+			&& $primary_model_row
+		)
+		) {
+			if ($relation instanceof EE_Belongs_To_Relation) {
+				$related_model_name_maybe_plural = strtolower($related_model->get_this_model_name());
+			} else {
+				$related_model_name_maybe_plural = EEH_Inflector::pluralize_and_lower(
+					$related_model->get_this_model_name()
+				);
+			}
+			throw new RestException(
+				sprintf('rest_%s_cannot_list', $related_model_name_maybe_plural),
+				sprintf(
+					__(
+						'Sorry, you are not allowed to list %1$s related to %2$s. Missing permissions: %3$s',
+						'event_espresso'
+					),
+					$related_model_name_maybe_plural,
+					$relation->get_this_model()->get_this_model_name(),
+					implode(
+						',',
+						array_keys(
+							Capabilities::getMissingPermissions($related_model, $context)
+						)
+					)
+				),
+				array('status' => 403)
+			);
+		}
+
+		$this->checkPassword(
+			$model,
+			$primary_model_row,
+			$restricted_query_params,
+			$request
+		);
+		$query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
+		foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
+			$query_params[0][ $relation->get_this_model()->get_this_model_name()
+							  . '.'
+							  . $where_condition_key ] = $where_condition_value;
+		}
+		$query_params['default_where_conditions'] = 'none';
+		$query_params['caps'] = $context;
+		if (! $request->get_header('no_rest_headers')) {
+			$this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
+		}
+		/** @type array $results */
+		$results = $relation->get_other_model()->get_all_wpdb_results($query_params);
+		$nice_results = array();
+		foreach ($results as $result) {
+			$nice_result = $this->createEntityFromWpdbResult(
+				$relation->get_other_model(),
+				$result,
+				$request
+			);
+			if ($relation instanceof \EE_HABTM_Relation) {
+				// put the unusual stuff (properties from the HABTM relation) first, and make sure
+				// if there are conflicts we prefer the properties from the main model
+				$join_model_result = $this->createEntityFromWpdbResult(
+					$relation->get_join_model(),
+					$result,
+					$request
+				);
+				$joined_result = array_merge($nice_result, $join_model_result);
+				// but keep the meta stuff from the main model
+				if (isset($nice_result['meta'])) {
+					$joined_result['meta'] = $nice_result['meta'];
+				}
+				$nice_result = $joined_result;
+			}
+			$nice_results[] = $nice_result;
+		}
+		if ($relation instanceof EE_Belongs_To_Relation) {
+			return array_shift($nice_results);
+		} else {
+			return $nice_results;
+		}
+	}
+
+
+	/**
+	 * Gets the collection for given relation object
+	 * The same as Read::get_entities_from_model(), except if the relation
+	 * is a HABTM relation, in which case it merges any non-foreign-key fields from
+	 * the join-model-object into the results
+	 *
+	 * @param string                  $id the ID of the thing we are fetching related stuff from
+	 * @param \EE_Model_Relation_Base $relation
+	 * @param WP_REST_Request         $request
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function getEntitiesFromRelation($id, $relation, $request)
+	{
+		if (! $relation->get_this_model()->has_primary_key_field()) {
+			throw new EE_Error(
+				sprintf(
+					__(
+					// @codingStandardsIgnoreStart
+						'Read::get_entities_from_relation should only be called from a model with a primary key, it was called from %1$s',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					),
+					$relation->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		// can we edit that main item?
+		// if not, show nothing but an error
+		// otherwise, please proceed
+		return $this->getEntitiesFromRelationUsingModelQueryParams(
+			array(
+				array(
+					$relation->get_this_model()->primary_key_name() => $id,
+				),
+			),
+			$relation,
+			$request
+		);
+	}
+
+
+	/**
+	 * Sets the headers that are based on the model and query params,
+	 * like the total records. This should only be called on the original request
+	 * from the client, not on subsequent internal
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_params
+	 * @return void
+	 */
+	protected function setHeadersFromQueryParams($model, $query_params)
+	{
+		$this->setDebugInfo('model query params', $query_params);
+		$this->setDebugInfo(
+			'missing caps',
+			Capabilities::getMissingPermissionsString($model, $query_params['caps'])
+		);
+		// normally the limit to a 2-part array, where the 2nd item is the limit
+		if (! isset($query_params['limit'])) {
+			$query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (is_array($query_params['limit'])) {
+			$limit_parts = $query_params['limit'];
+		} else {
+			$limit_parts = explode(',', $query_params['limit']);
+			if (count($limit_parts) == 1) {
+				$limit_parts = array(0, $limit_parts[0]);
+			}
+		}
+		// remove the group by and having parts of the query, as those will
+		// make the sql query return an array of values, instead of just a single value
+		unset($query_params['group_by'], $query_params['having'], $query_params['limit']);
+		$count = $model->count($query_params, null, true);
+		$pages = $count / $limit_parts[1];
+		$this->setResponseHeader('Total', $count, false);
+		$this->setResponseHeader('PageSize', $limit_parts[1], false);
+		$this->setResponseHeader('TotalPages', ceil($pages), false);
+	}
+
+
+	/**
+	 * Changes database results into REST API entities
+	 *
+	 * @param EEM_Base $model
+	 * @param array $db_row like results from $wpdb->get_results()
+	 * @param WP_REST_Request $rest_request
+	 * @param string $deprecated no longer used
+	 * @return array ready for being converted into json for sending to client
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 */
+	public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
+	{
+		if (! $rest_request instanceof WP_REST_Request) {
+			// ok so this was called in the old style, where the 3rd arg was
+			// $include, and the 4th arg was $context
+			// now setup the request just to avoid fatal errors, although we won't be able
+			// to truly make use of it because it's kinda devoid of info
+			$rest_request = new WP_REST_Request();
+			$rest_request->set_param('include', $rest_request);
+			$rest_request->set_param('caps', $deprecated);
+		}
+		if ($rest_request->get_param('caps') == null) {
+			$rest_request->set_param('caps', EEM_Base::caps_read);
+		}
+		$current_user_full_access_to_entity = $model->currentUserCan(
+			EEM_Base::caps_read_admin,
+			$model->deduce_fields_n_values_from_cols_n_values($db_row)
+		);
+		$entity_array = $this->createBareEntityFromWpdbResults($model, $db_row);
+		$entity_array = $this->addExtraFields($model, $db_row, $entity_array);
+		$entity_array['_links'] = $this->getEntityLinks($model, $db_row, $entity_array);
+		// when it's a regular read request for a model with a password and the password wasn't provided
+		// remove the password protected fields
+		$has_protected_fields = false;
+		try {
+			$this->checkPassword(
+				$model,
+				$db_row,
+				$model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				),
+				$rest_request
+			);
+		} catch (RestPasswordRequiredException $e) {
+			if ($model->hasPassword()) {
+				// just remove protected fields
+				$has_protected_fields = true;
+				$entity_array = Capabilities::filterOutPasswordProtectedFields(
+					$entity_array,
+					$model,
+					$this->getModelVersionInfo()
+				);
+			} else {
+				// that's a problem. None of this should be accessible if no password was provided
+				throw $e;
+			}
+		}
+
+		$entity_array['_calculated_fields'] = $this->getEntityCalculations($model, $db_row, $rest_request, $has_protected_fields);
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		// add an empty protected property for now. If it's still around after we remove everything the request didn't
+		// want, we'll populate it then. k?
+		$entity_array['_protected'] = array();
+		// remove any properties the request didn't want. This way _protected won't bother mentioning them
+		$entity_array = $this->includeOnlyRequestedProperties($model, $rest_request, $entity_array);
+		$entity_array = $this->includeRequestedModels($model, $rest_request, $entity_array, $db_row, $has_protected_fields);
+		// if they still wanted the _protected property, add it.
+		if (isset($entity_array['_protected'])) {
+			$entity_array = $this->addProtectedProperty($model, $entity_array, $has_protected_fields);
+		}
+		$entity_array = apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			$entity_array,
+			$model,
+			$rest_request->get_param('caps'),
+			$rest_request,
+			$this
+		);
+		if (! $current_user_full_access_to_entity) {
+			$result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
+				$entity_array,
+				$model,
+				$rest_request->get_param('caps'),
+				$this->getModelVersionInfo()
+			);
+		} else {
+			$result_without_inaccessible_fields = $entity_array;
+		}
+		$this->setDebugInfo(
+			'inaccessible fields',
+			array_keys(array_diff_key((array) $entity_array, (array) $result_without_inaccessible_fields))
+		);
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_return',
+			$result_without_inaccessible_fields,
+			$model,
+			$rest_request->get_param('caps')
+		);
+	}
+
+	/**
+	 * Returns an array describing which fields can be protected, and which actually were removed this request
+	 * @since 4.9.74.p
+	 * @param $model
+	 * @param $results_so_far
+	 * @param $protected
+	 * @return array results
+	 */
+	protected function addProtectedProperty(EEM_Base $model, $results_so_far, $protected)
+	{
+		if (! $model->hasPassword() || ! $protected) {
+			return $results_so_far;
+		}
+		$password_field = $model->getPasswordField();
+		$all_protected = array_merge(
+			array($password_field->get_name()),
+			$password_field->protectedFields()
+		);
+		$fields_included = array_keys($results_so_far);
+		$fields_included = array_intersect(
+			$all_protected,
+			$fields_included
+		);
+		foreach ($fields_included as $field_name) {
+			$results_so_far['_protected'][] = $field_name ;
+		}
+		return $results_so_far;
+	}
+
+	/**
+	 * Creates a REST entity array (JSON object we're going to return in the response, but
+	 * for now still a PHP array, but soon enough we'll call json_encode on it, don't worry),
+	 * from $wpdb->get_row( $sql, ARRAY_A)
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @return array entity mostly ready for converting to JSON and sending in the response
+	 */
+	protected function createBareEntityFromWpdbResults(EEM_Base $model, $db_row)
+	{
+		$result = $model->deduce_fields_n_values_from_cols_n_values($db_row);
+		$result = array_intersect_key(
+			$result,
+			$this->getModelVersionInfo()->fieldsOnModelInThisVersion($model)
+		);
+		// if this is a CPT, we need to set the global $post to it,
+		// otherwise shortcodes etc won't work properly while rendering it
+		if ($model instanceof \EEM_CPT_Base) {
+			$do_chevy_shuffle = true;
+		} else {
+			$do_chevy_shuffle = false;
+		}
+		if ($do_chevy_shuffle) {
+			global $post;
+			$old_post = $post;
+			$post = get_post($result[ $model->primary_key_name() ]);
+			if (! $post instanceof \WP_Post) {
+				// well that's weird, because $result is what we JUST fetched from the database
+				throw new RestException(
+					'error_fetching_post_from_database_results',
+					esc_html__(
+						'An item was retrieved from the database but it\'s not a WP_Post like it should be.',
+						'event_espresso'
+					)
+				);
+			}
+			$model_object_classname = 'EE_' . $model->get_this_model_name();
+			$post->{$model_object_classname} = \EE_Registry::instance()->load_class(
+				$model_object_classname,
+				$result,
+				false,
+				false
+			);
+		}
+		foreach ($result as $field_name => $field_value) {
+			$field_obj = $model->field_settings_for($field_name);
+			if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
+				unset($result[ $field_name ]);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($this->isSubclassOfOne(
+				$field_obj,
+				$this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
+			)
+			) {
+				$result[ $field_name ] = array(
+					'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
+					'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
+				);
+			} elseif ($field_obj instanceof \EE_Datetime_Field) {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value);
+				// if the value is null, but we're not supposed to permit null, then set to the field's default
+				if (is_null($field_value)) {
+					$field_value = $field_obj->getDefaultDateTimeObj();
+				}
+				if (is_null($field_value)) {
+					$gmt_date = $local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				} else {
+					$timezone = $field_value->getTimezone();
+					EEH_DTT_Helper::setTimezone($field_value, new DateTimeZone('UTC'));
+					$gmt_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+					EEH_DTT_Helper::setTimezone($field_value, $timezone);
+					$local_date = ModelDataTranslator::prepareFieldValuesForJson(
+						$field_obj,
+						$field_value,
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$result[ $field_name . '_gmt' ] = $gmt_date;
+				$result[ $field_name ] = $local_date;
+			} else {
+				$result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+			}
+		}
+		if ($do_chevy_shuffle) {
+			$post = $old_post;
+		}
+		return $result;
+	}
+
+
+	/**
+	 * Takes a value all the way from the DB representation, to the model object's representation, to the
+	 * user-facing PHP representation, to the REST API representation. (Assumes you've already taken from the DB
+	 * representation using $field_obj->prepare_for_set_from_db())
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $value  as it's stored on a model object
+	 * @param string              $format valid values are 'normal' (default), 'pretty', 'datetime_obj'
+	 * @return mixed
+	 * @throws ObjectDetectedException if $value contains a PHP object
+	 */
+	protected function prepareFieldObjValueForJson(EE_Model_Field_Base $field_obj, $value, $format = 'normal')
+	{
+		$value = $field_obj->prepare_for_set_from_db($value);
+		switch ($format) {
+			case 'pretty':
+				$value = $field_obj->prepare_for_pretty_echoing($value);
+				break;
+			case 'normal':
+			default:
+				$value = $field_obj->prepare_for_get($value);
+				break;
+		}
+		return ModelDataTranslator::prepareFieldValuesForJson(
+			$field_obj,
+			$value,
+			$this->getModelVersionInfo()->requestedVersion()
+		);
+	}
+
+
+	/**
+	 * Adds a few extra fields to the entity response
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $db_row
+	 * @param array    $entity_array
+	 * @return array modified entity
+	 */
+	protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
+	{
+		if ($model instanceof EEM_CPT_Base) {
+			$entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Gets links we want to add to the response
+	 *
+	 * @global \WP_REST_Server $wp_rest_server
+	 * @param EEM_Base         $model
+	 * @param array            $db_row
+	 * @param array            $entity_array
+	 * @return array the _links item in the entity
+	 */
+	protected function getEntityLinks($model, $db_row, $entity_array)
+	{
+		// add basic links
+		$links = array();
+		if ($model->has_primary_key_field()) {
+			$links['self'] = array(
+				array(
+					'href' => $this->getVersionedLinkTo(
+						EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+						. '/'
+						. $entity_array[ $model->primary_key_name() ]
+					),
+				),
+			);
+		}
+		$links['collection'] = array(
+			array(
+				'href' => $this->getVersionedLinkTo(
+					EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+				),
+			),
+		);
+		// add links to related models
+		if ($model->has_primary_key_field()) {
+			foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
+				$related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
+				$links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+					array(
+						'href'   => $this->getVersionedLinkTo(
+							EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
+							. '/'
+							. $entity_array[ $model->primary_key_name() ]
+							. '/'
+							. $related_model_part
+						),
+						'single' => $relation_obj instanceof EE_Belongs_To_Relation ? true : false,
+					),
+				);
+			}
+		}
+		return $links;
+	}
+
+
+	/**
+	 * Adds the included models indicated in the request to the entity provided
+	 *
+	 * @param EEM_Base $model
+	 * @param WP_REST_Request $rest_request
+	 * @param array $entity_array
+	 * @param array $db_row
+	 * @param boolean $included_items_protected if the original item is password protected, don't include any related models.
+	 * @return array the modified entity
+	 * @throws RestException
+	 */
+	protected function includeRequestedModels(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array,
+		$db_row = array(),
+		$included_items_protected = false
+	) {
+		// if $db_row not included, hope the entity array has what we need
+		if (! $db_row) {
+			$db_row = $entity_array;
+		}
+		$relation_settings = $this->getModelVersionInfo()->relationSettings($model);
+		foreach ($relation_settings as $relation_name => $relation_obj) {
+			$related_fields_to_include = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('include'),
+				$relation_name
+			);
+			$related_fields_to_calculate = $this->explodeAndGetItemsPrefixedWith(
+				$rest_request->get_param('calculate'),
+				$relation_name
+			);
+			// did they specify they wanted to include a related model, or
+			// specific fields from a related model?
+			// or did they specify to calculate a field from a related model?
+			if ($related_fields_to_include || $related_fields_to_calculate) {
+				// if so, we should include at least some part of the related model
+				$pretend_related_request = new WP_REST_Request();
+				$pretend_related_request->set_query_params(
+					array(
+						'caps'      => $rest_request->get_param('caps'),
+						'include'   => $related_fields_to_include,
+						'calculate' => $related_fields_to_calculate,
+						'password' => $rest_request->get_param('password')
+					)
+				);
+				$pretend_related_request->add_header('no_rest_headers', true);
+				$primary_model_query_params = $model->alter_query_params_to_restrict_by_ID(
+					$model->get_index_primary_key_string(
+						$model->deduce_fields_n_values_from_cols_n_values($db_row)
+					)
+				);
+				if (! $included_items_protected) {
+					try {
+						$related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
+							$primary_model_query_params,
+							$relation_obj,
+							$pretend_related_request
+						);
+					} catch (RestException $e) {
+						$related_results = null;
+					}
+				} else {
+					// they're protected, hide them.
+					$related_results = null;
+					$entity_array['_protected'][] = Read::getRelatedEntityName($relation_name, $relation_obj);
+				}
+				if ($related_results instanceof WP_Error || $related_results === null) {
+					$related_results = $relation_obj instanceof EE_Belongs_To_Relation ? null : array();
+				}
+				$entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+			}
+		}
+		return $entity_array;
+	}
+
+	/**
+	 * If the user has requested only specific properties (including meta properties like _links or _protected)
+	 * remove everything else.
+	 * @since 4.9.74.p
+	 * @param EEM_Base $model
+	 * @param WP_REST_Request $rest_request
+	 * @param $entity_array
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function includeOnlyRequestedProperties(
+		EEM_Base $model,
+		WP_REST_Request $rest_request,
+		$entity_array
+	) {
+
+		$includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
+		$includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
+		// if they passed in * or didn't specify any includes, return everything
+		if (! in_array('*', $includes_for_this_model)
+			&& ! empty($includes_for_this_model)
+		) {
+			if ($model->has_primary_key_field()) {
+				// always include the primary key. ya just gotta know that at least
+				$includes_for_this_model[] = $model->primary_key_name();
+			}
+			if ($this->explodeAndGetItemsPrefixedWith($rest_request->get_param('calculate'), '')) {
+				$includes_for_this_model[] = '_calculated_fields';
+			}
+			$entity_array = array_intersect_key($entity_array, array_flip($includes_for_this_model));
+		}
+		return $entity_array;
+	}
+
+
+	/**
+	 * Returns a new array with all the names of models removed. Eg
+	 * array( 'Event', 'Datetime.*', 'foobar' ) would become array( 'Datetime.*', 'foobar' )
+	 *
+	 * @param array $arr
+	 * @return array
+	 */
+	private function removeModelNamesFromArray($arr)
+	{
+		return array_diff($arr, array_keys(EE_Registry::instance()->non_abstract_db_models));
+	}
+
+
+	/**
+	 * Gets the calculated fields for the response
+	 *
+	 * @param EEM_Base        $model
+	 * @param array           $wpdb_row
+	 * @param WP_REST_Request $rest_request
+	 * @param boolean $row_is_protected whether this row is password protected or not
+	 * @return \stdClass the _calculations item in the entity
+	 * @throws ObjectDetectedException if a default value has a PHP object, which should never do (and if we
+	 * did, let's know about it ASAP, so let the exception bubble up)
+	 */
+	protected function getEntityCalculations($model, $wpdb_row, $rest_request, $row_is_protected = false)
+	{
+		$calculated_fields = $this->explodeAndGetItemsPrefixedWith(
+			$rest_request->get_param('calculate'),
+			''
+		);
+		// note: setting calculate=* doesn't do anything
+		$calculated_fields_to_return = new \stdClass();
+		$protected_fields = array();
+		foreach ($calculated_fields as $field_to_calculate) {
+			try {
+				// it's password protected, so they shouldn't be able to read this. Remove the value
+				$schema = $this->fields_calculator->getJsonSchemaForModel($model);
+				if ($row_is_protected
+					&& isset($schema['properties'][ $field_to_calculate ]['protected'])
+					&& $schema['properties'][ $field_to_calculate ]['protected']) {
+					$calculated_value = null;
+					$protected_fields[] = $field_to_calculate;
+					if ($schema['properties'][ $field_to_calculate ]['type']) {
+						switch ($schema['properties'][ $field_to_calculate ]['type']) {
+							case 'boolean':
+								$calculated_value = false;
+								break;
+							case 'integer':
+								$calculated_value = 0;
+								break;
+							case 'string':
+								$calculated_value = '';
+								break;
+							case 'array':
+								$calculated_value = array();
+								break;
+							case 'object':
+								$calculated_value = new stdClass();
+								break;
+						}
+					}
+				} else {
+					$calculated_value = ModelDataTranslator::prepareFieldValueForJson(
+						null,
+						$this->fields_calculator->retrieveCalculatedFieldValue(
+							$model,
+							$field_to_calculate,
+							$wpdb_row,
+							$rest_request,
+							$this
+						),
+						$this->getModelVersionInfo()->requestedVersion()
+					);
+				}
+				$calculated_fields_to_return->{$field_to_calculate} = $calculated_value;
+			} catch (RestException $e) {
+				// if we don't have permission to read it, just leave it out. but let devs know about the problem
+				$this->setResponseHeader(
+					'Notices-Field-Calculation-Errors['
+					. $e->getStringCode()
+					. ']['
+					. $model->get_this_model_name()
+					. ']['
+					. $field_to_calculate
+					. ']',
+					$e->getMessage(),
+					true
+				);
+			}
+		}
+		$calculated_fields_to_return->_protected = $protected_fields;
+		return $calculated_fields_to_return;
+	}
+
+
+	/**
+	 * Gets the full URL to the resource, taking the requested version into account
+	 *
+	 * @param string $link_part_after_version_and_slash eg "events/10/datetimes"
+	 * @return string url eg "http://mysite.com/wp-json/ee/v4.6/events/10/datetimes"
+	 */
+	public function getVersionedLinkTo($link_part_after_version_and_slash)
+	{
+		return rest_url(
+			EED_Core_Rest_Api::get_versioned_route_to(
+				$link_part_after_version_and_slash,
+				$this->getModelVersionInfo()->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the correct lowercase name for the relation in the API according
+	 * to the relation's type
+	 *
+	 * @param string                  $relation_name
+	 * @param \EE_Model_Relation_Base $relation_obj
+	 * @return string
+	 */
+	public static function getRelatedEntityName($relation_name, $relation_obj)
+	{
+		if ($relation_obj instanceof EE_Belongs_To_Relation) {
+			return strtolower($relation_name);
+		} else {
+			return EEH_Inflector::pluralize_and_lower($relation_name);
+		}
+	}
+
+
+	/**
+	 * Gets the one model object with the specified id for the specified model
+	 *
+	 * @param EEM_Base        $model
+	 * @param WP_REST_Request $request
+	 * @return array
+	 */
+	public function getEntityFromModel($model, $request)
+	{
+		$context = $this->validateContext($request->get_param('caps'));
+		return $this->getOneOrReportPermissionError($model, $request, $context);
+	}
+
+
+	/**
+	 * If a context is provided which isn't valid, maybe it was added in a future
+	 * version so just treat it as a default read
+	 *
+	 * @param string $context
+	 * @return string array key of EEM_Base::cap_contexts_to_cap_action_map()
+	 */
+	public function validateContext($context)
+	{
+		if (! $context) {
+			$context = EEM_Base::caps_read;
+		}
+		$valid_contexts = EEM_Base::valid_cap_contexts();
+		if (in_array($context, $valid_contexts)) {
+			return $context;
+		} else {
+			return EEM_Base::caps_read;
+		}
+	}
+
+
+	/**
+	 * Verifies the passed in value is an allowable default where conditions value.
+	 *
+	 * @param $default_query_params
+	 * @return string
+	 */
+	public function validateDefaultQueryParams($default_query_params)
+	{
+		$valid_default_where_conditions_for_api_calls = array(
+			EEM_Base::default_where_conditions_all,
+			EEM_Base::default_where_conditions_minimum_all,
+			EEM_Base::default_where_conditions_minimum_others,
+		);
+		if (! $default_query_params) {
+			$default_query_params = EEM_Base::default_where_conditions_all;
+		}
+		if (in_array(
+			$default_query_params,
+			$valid_default_where_conditions_for_api_calls,
+			true
+		)) {
+			return $default_query_params;
+		} else {
+			return EEM_Base::default_where_conditions_all;
+		}
+	}
+
+
+	/**
+	 * Translates API filter get parameter into model query params @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions.
+	 * Note: right now the query parameter keys for fields (and related fields)
+	 * can be left as-is, but it's quite possible this will change someday.
+	 * Also, this method's contents might be candidate for moving to Model_Data_Translator
+	 *
+	 * @param EEM_Base $model
+	 * @param array    $query_parameters  from $_GET parameter @see Read:handle_request_get_all
+	 * @return array model query params (@see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions)
+	 *                                    or FALSE to indicate that absolutely no results should be returned
+	 * @throws EE_Error
+	 * @throws RestException
+	 */
+	public function createModelQueryParams($model, $query_params)
+	{
+		$model_query_params = array();
+		if (isset($query_params['where'])) {
+			$model_query_params[0] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['where'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order_by'])) {
+			$order_by = $query_params['order_by'];
+		} elseif (isset($query_params['orderby'])) {
+			$order_by = $query_params['orderby'];
+		} else {
+			$order_by = null;
+		}
+		if ($order_by !== null) {
+			if (is_array($order_by)) {
+				$order_by = ModelDataTranslator::prepareFieldNamesInArrayKeysFromJson($order_by);
+			} else {
+				// it's a single item
+				$order_by = ModelDataTranslator::prepareFieldNameFromJson($order_by);
+			}
+			$model_query_params['order_by'] = $order_by;
+		}
+		if (isset($query_params['group_by'])) {
+			$group_by = $query_params['group_by'];
+		} elseif (isset($query_params['groupby'])) {
+			$group_by = $query_params['groupby'];
+		} else {
+			$group_by = array_keys($model->get_combined_primary_key_fields());
+		}
+		// make sure they're all real names
+		if (is_array($group_by)) {
+			$group_by = ModelDataTranslator::prepareFieldNamesFromJson($group_by);
+		}
+		if ($group_by !== null) {
+			$model_query_params['group_by'] = $group_by;
+		}
+		if (isset($query_params['having'])) {
+			$model_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$query_params['having'],
+				$model,
+				$this->getModelVersionInfo()->requestedVersion()
+			);
+		}
+		if (isset($query_params['order'])) {
+			$model_query_params['order'] = $query_params['order'];
+		}
+		if (isset($query_params['mine'])) {
+			$model_query_params = $model->alter_query_params_to_only_include_mine($model_query_params);
+		}
+		if (isset($query_params['limit'])) {
+			// limit should be either a string like '23' or '23,43', or an array with two items in it
+			if (! is_array($query_params['limit'])) {
+				$limit_array = explode(',', (string) $query_params['limit']);
+			} else {
+				$limit_array = $query_params['limit'];
+			}
+			$sanitized_limit = array();
+			foreach ($limit_array as $key => $limit_part) {
+				if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+					throw new EE_Error(
+						sprintf(
+							__(
+							// @codingStandardsIgnoreStart
+								'An invalid limit filter was provided. It was: %s. If the EE4 JSON REST API weren\'t in debug mode, this message would not appear.',
+								// @codingStandardsIgnoreEnd
+								'event_espresso'
+							),
+							wp_json_encode($query_params['limit'])
+						)
+					);
+				}
+				$sanitized_limit[] = (int) $limit_part;
+			}
+			$model_query_params['limit'] = implode(',', $sanitized_limit);
+		} else {
+			$model_query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
+		}
+		if (isset($query_params['caps'])) {
+			$model_query_params['caps'] = $this->validateContext($query_params['caps']);
+		} else {
+			$model_query_params['caps'] = EEM_Base::caps_read;
+		}
+		if (isset($query_params['default_where_conditions'])) {
+			$model_query_params['default_where_conditions'] = $this->validateDefaultQueryParams(
+				$query_params['default_where_conditions']
+			);
+		}
+		// if this is a model protected by a password on another model, exclude the password protected
+		// entities by default. But if they passed in a password, try to show them all. If the password is wrong,
+		// though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
+		if (! $model->hasPassword()
+			&& $model->restrictedByRelatedModelPassword()
+			&& $model_query_params['caps'] === EEM_Base::caps_read) {
+			if (empty($query_params['password'])) {
+				$model_query_params['exclude_protected'] = true;
+			}
+		}
+
+		return apply_filters('FHEE__Read__create_model_query_params', $model_query_params, $query_params, $model);
+	}
+
+
+	/**
+	 * Changes the REST-style query params for use in the models
+	 *
+	 * @deprecated
+	 * @param EEM_Base $model
+	 * @param array    $query_params sub-array from @see EEM_Base::get_all()
+	 * @return array
+	 */
+	public function prepareRestQueryParamsKeyForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * @deprecated instead use ModelDataTranslator::prepareFieldValuesFromJson()
+	 * @param $model
+	 * @param $query_params
+	 * @return array
+	 */
+	public function prepareRestQueryParamsValuesForModels($model, $query_params)
+	{
+		$model_ready_query_params = array();
+		foreach ($query_params as $key => $value) {
+			if (is_array($value)) {
+				$model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+			} else {
+				$model_ready_query_params[ $key ] = $value;
+			}
+		}
+		return $model_ready_query_params;
+	}
+
+
+	/**
+	 * Explodes the string on commas, and only returns items with $prefix followed by a period.
+	 * If no prefix is specified, returns items with no period.
+	 *
+	 * @param string|array $string_to_explode eg "jibba,jabba, blah, blah, blah" or array('jibba', 'jabba' )
+	 * @param string       $prefix            "Event" or "foobar"
+	 * @return array $string_to_exploded exploded on COMMAS, and if a prefix was specified
+	 *                                        we only return strings starting with that and a period; if no prefix was
+	 *                                        specified we return all items containing NO periods
+	 */
+	public function explodeAndGetItemsPrefixedWith($string_to_explode, $prefix)
+	{
+		if (is_string($string_to_explode)) {
+			$exploded_contents = explode(',', $string_to_explode);
+		} elseif (is_array($string_to_explode)) {
+			$exploded_contents = $string_to_explode;
+		} else {
+			$exploded_contents = array();
+		}
+		// if the string was empty, we want an empty array
+		$exploded_contents = array_filter($exploded_contents);
+		$contents_with_prefix = array();
+		foreach ($exploded_contents as $item) {
+			$item = trim($item);
+			// if no prefix was provided, so we look for items with no "." in them
+			if (! $prefix) {
+				// does this item have a period?
+				if (strpos($item, '.') === false) {
+					// if not, then its what we're looking for
+					$contents_with_prefix[] = $item;
+				}
+			} elseif (strpos($item, $prefix . '.') === 0) {
+				// this item has the prefix and a period, grab it
+				$contents_with_prefix[] = substr(
+					$item,
+					strpos($item, $prefix . '.') + strlen($prefix . '.')
+				);
+			} elseif ($item === $prefix) {
+				// this item is JUST the prefix
+				// so let's grab everything after, which is a blank string
+				$contents_with_prefix[] = '';
+			}
+		}
+		return $contents_with_prefix;
+	}
+
+
+	/**
+	 * @deprecated since 4.8.36.rc.001 You should instead use Read::explode_and_get_items_prefixed_with.
+	 * Deprecated because its return values were really quite confusing- sometimes it returned
+	 * an empty array (when the include string was blank or '*') or sometimes it returned
+	 * array('*') (when you provided a model and a model of that kind was found).
+	 * Parses the $include_string so we fetch all the field names relating to THIS model
+	 * (ie have NO period in them), or for the provided model (ie start with the model
+	 * name and then a period).
+	 * @param string $include_string @see Read:handle_request_get_all
+	 * @param string $model_name
+	 * @return array of fields for this model. If $model_name is provided, then
+	 *                               the fields for that model, with the model's name removed from each.
+	 *                               If $include_string was blank or '*' returns an empty array
+	 */
+	public function extractIncludesForThisModel($include_string, $model_name = null)
+	{
+		if (is_array($include_string)) {
+			$include_string = implode(',', $include_string);
+		}
+		if ($include_string === '*' || $include_string === '') {
+			return array();
+		}
+		$includes = explode(',', $include_string);
+		$extracted_fields_to_include = array();
+		if ($model_name) {
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, $model_name . '.') === 0) {
+					// found the model name at the exact start
+					$field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+					$extracted_fields_to_include[] = $field_sans_model_name;
+				} elseif ($field_to_include == $model_name) {
+					$extracted_fields_to_include[] = '*';
+				}
+			}
+		} else {
+			// look for ones with no period
+			foreach ($includes as $field_to_include) {
+				$field_to_include = trim($field_to_include);
+				if (strpos($field_to_include, '.') === false
+					&& ! $this->getModelVersionInfo()->isModelNameInThisVersion($field_to_include)
+				) {
+					$extracted_fields_to_include[] = $field_to_include;
+				}
+			}
+		}
+		return $extracted_fields_to_include;
+	}
+
+
+	/**
+	 * Gets the single item using the model according to the request in the context given, otherwise
+	 * returns that it's inaccessible to the current user
+	 *
+	 * @param EEM_Base $model
+	 * @param WP_REST_Request $request
+	 * @param null $context
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function getOneOrReportPermissionError(EEM_Base $model, WP_REST_Request $request, $context = null)
+	{
+		$query_params = array(array($model->primary_key_name() => $request->get_param('id')), 'limit' => 1);
+		if ($model instanceof EEM_Soft_Delete_Base) {
+			$query_params = $model->alter_query_params_so_deleted_and_undeleted_items_included($query_params);
+		}
+		$restricted_query_params = $query_params;
+		$restricted_query_params['caps'] = $context;
+		$this->setDebugInfo('model query params', $restricted_query_params);
+		$model_rows = $model->get_all_wpdb_results($restricted_query_params);
+		if (! empty($model_rows)) {
+			return $this->createEntityFromWpdbResult(
+				$model,
+				reset($model_rows),
+				$request
+			);
+		} else {
+			// ok let's test to see if we WOULD have found it, had we not had restrictions from missing capabilities
+			$lowercase_model_name = strtolower($model->get_this_model_name());
+			if ($model->exists($query_params)) {
+				// you got shafted- it existed but we didn't want to tell you!
+				throw new RestException(
+					'rest_user_cannot_' . $context,
+					sprintf(
+						__('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
+						$context,
+						$lowercase_model_name,
+						Capabilities::getMissingPermissionsString(
+							$model,
+							$context
+						)
+					),
+					array('status' => 403)
+				);
+			} else {
+				// it's not you. It just doesn't exist
+				throw new RestException(
+					sprintf('rest_%s_invalid_id', $lowercase_model_name),
+					sprintf(__('Invalid %s ID.', 'event_espresso'), $lowercase_model_name),
+					array('status' => 404)
+				);
+			}
+		}
+	}
+
+	/**
+	 * Checks that if this content requires a password to be read, that it's been provided and is correct.
+	 * @since 4.9.74.p
+	 * @param EEM_Base $model
+	 * @param $model_row
+	 * @param $query_params Adds 'default_where_conditions' => 'minimum' to ensure we don't confuse trashed with
+	 *                      password protected.
+	 * @param WP_REST_Request $request
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws RestPasswordRequiredException
+	 * @throws RestPasswordIncorrectException
+	 * @throws \EventEspresso\core\exceptions\ModelConfigurationException
+	 * @throws ReflectionException
+	 */
+	protected function checkPassword(EEM_Base $model, $model_row, $query_params, WP_REST_Request $request)
+	{
+		$query_params['default_where_conditions'] = 'minimum';
+		// stuff is only "protected" for front-end requests. Elsewhere, you either get full permission to access the object
+		// or you don't.
+		$request_caps = $request->get_param('caps');
+		if (isset($request_caps) && $request_caps !== EEM_Base::caps_read) {
+			return;
+		}
+		// if this entity requires a password, they better give it and it better be right!
+		if ($model->hasPassword()
+			&& $model_row[ $model->getPasswordField()->get_qualified_column() ] !== '') {
+			if (empty($request['password'])) {
+				throw new RestPasswordRequiredException();
+			} elseif (!hash_equals(
+				$model_row[ $model->getPasswordField()->get_qualified_column() ],
+				$request['password']
+			)) {
+				throw new RestPasswordIncorrectException();
+			}
+		} // wait! maybe this content is password protected
+		elseif ($model->restrictedByRelatedModelPassword()
+			&& $request->get_param('caps') === EEM_Base::caps_read) {
+			$password_supplied = $request->get_param('password');
+			if (empty($password_supplied)) {
+				$query_params['exclude_protected'] = true;
+				if (!$model->exists($query_params)) {
+					throw new RestPasswordRequiredException();
+				}
+			} else {
+				$query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
+				if (!$model->exists($query_params)) {
+					throw new RestPasswordIncorrectException();
+				}
+			}
+		}
+	}
 }

Spacing +68 added lines, -68 removed lines

@@ -78,7 +78,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -119,7 +119,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return array();
             }
             // get the model for this version
@@ -176,11 +176,11 @@ 
      */
     protected function translateDefaultsForRestResponse($field_name, EE_Model_Field_Base $field, array $schema)
     {
-        if (isset($schema['properties'][ $field_name ]['default'])) {
-            if (is_array($schema['properties'][ $field_name ]['default'])) {
-                foreach ($schema['properties'][ $field_name ]['default'] as $default_key => $default_value) {
+        if (isset($schema['properties'][$field_name]['default'])) {
+            if (is_array($schema['properties'][$field_name]['default'])) {
+                foreach ($schema['properties'][$field_name]['default'] as $default_key => $default_value) {
                     if ($default_key === 'raw') {
-                        $schema['properties'][ $field_name ]['default'][ $default_key ] =
+                        $schema['properties'][$field_name]['default'][$default_key] =
                             ModelDataTranslator::prepareFieldValueForJson(
                                 $field,
                                 $default_value,
@@ -189,9 +189,9 @@ 
                     }
                 }
             } else {
-                $schema['properties'][ $field_name ]['default'] = ModelDataTranslator::prepareFieldValueForJson(
+                $schema['properties'][$field_name]['default'] = ModelDataTranslator::prepareFieldValueForJson(
                     $field,
-                    $schema['properties'][ $field_name ]['default'],
+                    $schema['properties'][$field_name]['default'],
                     $this->getModelVersionInfo()->requestedVersion()
                 );
             }
@@ -213,9 +213,9 @@ 
     protected function maybeAddExtraFieldsToSchema($field_name, EE_Model_Field_Base $field, array $schema)
     {
         if ($field instanceof EE_Datetime_Field) {
-            $schema['properties'][ $field_name . '_gmt' ] = $field->getSchema();
+            $schema['properties'][$field_name.'_gmt'] = $field->getSchema();
             // modify the description
-            $schema['properties'][ $field_name . '_gmt' ]['description'] = sprintf(
+            $schema['properties'][$field_name.'_gmt']['description'] = sprintf(
                 esc_html__('%s - the value for this field is in GMT.', 'event_espresso'),
                 wp_specialchars_decode($field->get_nicename(), ENT_QUOTES)
             );
@@ -258,7 +258,7 @@ 
         $controller = LoaderFactory::getLoader()->getNew('EventEspresso\core\libraries\rest_api\controllers\model\Read');
         try {
             $controller->setRequestedVersion($version);
-            if (! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
+            if ( ! $controller->getModelVersionInfo()->isModelNameInThisVersion($model_name)) {
                 return $controller->sendResponse(
                     new WP_Error(
                         'endpoint_parsing_error',
@@ -337,7 +337,7 @@ 
     public function getEntitiesFromModel($model, $request)
     {
         $query_params = $this->createModelQueryParams($model, $request->get_params());
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $query_params['caps'])) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_%s_cannot_list', $model_name_plural),
@@ -349,14 +349,14 @@ 
                 array('status' => 403)
             );
         }
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($model, $query_params);
         }
         /** @type array $results */
         $results = $model->get_all_wpdb_results($query_params);
         $nice_results = array();
         foreach ($results as $result) {
-            $nice_results[] =  $this->createEntityFromWpdbResult(
+            $nice_results[] = $this->createEntityFromWpdbResult(
                 $model,
                 $result,
                 $request
@@ -390,7 +390,7 @@ 
         $context = $this->validateContext($request->get_param('caps'));
         $model = $relation->get_this_model();
         $related_model = $relation->get_other_model();
-        if (! isset($primary_model_query_params[0])) {
+        if ( ! isset($primary_model_query_params[0])) {
             $primary_model_query_params[0] = array();
         }
         // check if they can access the 1st model object
@@ -413,7 +413,7 @@ 
         if (is_array($primary_model_rows)) {
             $primary_model_row = reset($primary_model_rows);
         }
-        if (! (
+        if ( ! (
             Capabilities::currentUserHasPartialAccessTo($related_model, $context)
             && $primary_model_row
         )
@@ -453,13 +453,13 @@ 
         );
         $query_params = $this->createModelQueryParams($relation->get_other_model(), $request->get_params());
         foreach ($primary_model_query_params[0] as $where_condition_key => $where_condition_value) {
-            $query_params[0][ $relation->get_this_model()->get_this_model_name()
+            $query_params[0][$relation->get_this_model()->get_this_model_name()
                               . '.'
-                              . $where_condition_key ] = $where_condition_value;
+                              . $where_condition_key] = $where_condition_value;
         }
         $query_params['default_where_conditions'] = 'none';
         $query_params['caps'] = $context;
-        if (! $request->get_header('no_rest_headers')) {
+        if ( ! $request->get_header('no_rest_headers')) {
             $this->setHeadersFromQueryParams($relation->get_other_model(), $query_params);
         }
         /** @type array $results */
@@ -510,7 +510,7 @@ 
      */
     public function getEntitiesFromRelation($id, $relation, $request)
     {
-        if (! $relation->get_this_model()->has_primary_key_field()) {
+        if ( ! $relation->get_this_model()->has_primary_key_field()) {
             throw new EE_Error(
                 sprintf(
                     __(
@@ -555,7 +555,7 @@ 
             Capabilities::getMissingPermissionsString($model, $query_params['caps'])
         );
         // normally the limit to a 2-part array, where the 2nd item is the limit
-        if (! isset($query_params['limit'])) {
+        if ( ! isset($query_params['limit'])) {
             $query_params['limit'] = EED_Core_Rest_Api::get_default_query_limit();
         }
         if (is_array($query_params['limit'])) {
@@ -594,7 +594,7 @@ 
      */
     public function createEntityFromWpdbResult($model, $db_row, $rest_request, $deprecated = null)
     {
-        if (! $rest_request instanceof WP_REST_Request) {
+        if ( ! $rest_request instanceof WP_REST_Request) {
             // ok so this was called in the old style, where the 3rd arg was
             // $include, and the 4th arg was $context
             // now setup the request just to avoid fatal errors, although we won't be able
@@ -669,7 +669,7 @@ 
             $rest_request,
             $this
         );
-        if (! $current_user_full_access_to_entity) {
+        if ( ! $current_user_full_access_to_entity) {
             $result_without_inaccessible_fields = Capabilities::filterOutInaccessibleEntityFields(
                 $entity_array,
                 $model,
@@ -701,7 +701,7 @@ 
      */
     protected function addProtectedProperty(EEM_Base $model, $results_so_far, $protected)
     {
-        if (! $model->hasPassword() || ! $protected) {
+        if ( ! $model->hasPassword() || ! $protected) {
             return $results_so_far;
         }
         $password_field = $model->getPasswordField();
@@ -715,7 +715,7 @@ 
             $fields_included
         );
         foreach ($fields_included as $field_name) {
-            $results_so_far['_protected'][] = $field_name ;
+            $results_so_far['_protected'][] = $field_name;
         }
         return $results_so_far;
     }
@@ -746,8 +746,8 @@ 
         if ($do_chevy_shuffle) {
             global $post;
             $old_post = $post;
-            $post = get_post($result[ $model->primary_key_name() ]);
-            if (! $post instanceof \WP_Post) {
+            $post = get_post($result[$model->primary_key_name()]);
+            if ( ! $post instanceof \WP_Post) {
                 // well that's weird, because $result is what we JUST fetched from the database
                 throw new RestException(
                     'error_fetching_post_from_database_results',
@@ -757,7 +757,7 @@ 
                     )
                 );
             }
-            $model_object_classname = 'EE_' . $model->get_this_model_name();
+            $model_object_classname = 'EE_'.$model->get_this_model_name();
             $post->{$model_object_classname} = \EE_Registry::instance()->load_class(
                 $model_object_classname,
                 $result,
@@ -768,13 +768,13 @@ 
         foreach ($result as $field_name => $field_value) {
             $field_obj = $model->field_settings_for($field_name);
             if ($this->isSubclassOfOne($field_obj, $this->getModelVersionInfo()->fieldsIgnored())) {
-                unset($result[ $field_name ]);
+                unset($result[$field_name]);
             } elseif ($this->isSubclassOfOne(
                 $field_obj,
                 $this->getModelVersionInfo()->fieldsThatHaveRenderedFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'      => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'rendered' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -783,7 +783,7 @@ 
                 $this->getModelVersionInfo()->fieldsThatHavePrettyFormat()
             )
             ) {
-                $result[ $field_name ] = array(
+                $result[$field_name] = array(
                     'raw'    => $this->prepareFieldObjValueForJson($field_obj, $field_value),
                     'pretty' => $this->prepareFieldObjValueForJson($field_obj, $field_value, 'pretty'),
                 );
@@ -814,10 +814,10 @@ 
                         $this->getModelVersionInfo()->requestedVersion()
                     );
                 }
-                $result[ $field_name . '_gmt' ] = $gmt_date;
-                $result[ $field_name ] = $local_date;
+                $result[$field_name.'_gmt'] = $gmt_date;
+                $result[$field_name] = $local_date;
             } else {
-                $result[ $field_name ] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
+                $result[$field_name] = $this->prepareFieldObjValueForJson($field_obj, $field_value);
             }
         }
         if ($do_chevy_shuffle) {
@@ -869,7 +869,7 @@ 
     protected function addExtraFields(EEM_Base $model, $db_row, $entity_array)
     {
         if ($model instanceof EEM_CPT_Base) {
-            $entity_array['link'] = get_permalink($db_row[ $model->get_primary_key_field()->get_qualified_column() ]);
+            $entity_array['link'] = get_permalink($db_row[$model->get_primary_key_field()->get_qualified_column()]);
         }
         return $entity_array;
     }
@@ -894,7 +894,7 @@ 
                     'href' => $this->getVersionedLinkTo(
                         EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                         . '/'
-                        . $entity_array[ $model->primary_key_name() ]
+                        . $entity_array[$model->primary_key_name()]
                     ),
                 ),
             );
@@ -910,12 +910,12 @@ 
         if ($model->has_primary_key_field()) {
             foreach ($this->getModelVersionInfo()->relationSettings($model) as $relation_name => $relation_obj) {
                 $related_model_part = Read::getRelatedEntityName($relation_name, $relation_obj);
-                $links[ EED_Core_Rest_Api::ee_api_link_namespace . $related_model_part ] = array(
+                $links[EED_Core_Rest_Api::ee_api_link_namespace.$related_model_part] = array(
                     array(
                         'href'   => $this->getVersionedLinkTo(
                             EEH_Inflector::pluralize_and_lower($model->get_this_model_name())
                             . '/'
-                            . $entity_array[ $model->primary_key_name() ]
+                            . $entity_array[$model->primary_key_name()]
                             . '/'
                             . $related_model_part
                         ),
@@ -947,7 +947,7 @@ 
         $included_items_protected = false
     ) {
         // if $db_row not included, hope the entity array has what we need
-        if (! $db_row) {
+        if ( ! $db_row) {
             $db_row = $entity_array;
         }
         $relation_settings = $this->getModelVersionInfo()->relationSettings($model);
@@ -980,7 +980,7 @@ 
                         $model->deduce_fields_n_values_from_cols_n_values($db_row)
                     )
                 );
-                if (! $included_items_protected) {
+                if ( ! $included_items_protected) {
                     try {
                         $related_results = $this->getEntitiesFromRelationUsingModelQueryParams(
                             $primary_model_query_params,
@@ -998,7 +998,7 @@ 
                 if ($related_results instanceof WP_Error || $related_results === null) {
                     $related_results = $relation_obj instanceof EE_Belongs_To_Relation ? null : array();
                 }
-                $entity_array[ Read::getRelatedEntityName($relation_name, $relation_obj) ] = $related_results;
+                $entity_array[Read::getRelatedEntityName($relation_name, $relation_obj)] = $related_results;
             }
         }
         return $entity_array;
@@ -1023,7 +1023,7 @@ 
         $includes_for_this_model = $this->explodeAndGetItemsPrefixedWith($rest_request->get_param('include'), '');
         $includes_for_this_model = $this->removeModelNamesFromArray($includes_for_this_model);
         // if they passed in * or didn't specify any includes, return everything
-        if (! in_array('*', $includes_for_this_model)
+        if ( ! in_array('*', $includes_for_this_model)
             && ! empty($includes_for_this_model)
         ) {
             if ($model->has_primary_key_field()) {
@@ -1077,12 +1077,12 @@ 
                 // it's password protected, so they shouldn't be able to read this. Remove the value
                 $schema = $this->fields_calculator->getJsonSchemaForModel($model);
                 if ($row_is_protected
-                    && isset($schema['properties'][ $field_to_calculate ]['protected'])
-                    && $schema['properties'][ $field_to_calculate ]['protected']) {
+                    && isset($schema['properties'][$field_to_calculate]['protected'])
+                    && $schema['properties'][$field_to_calculate]['protected']) {
                     $calculated_value = null;
                     $protected_fields[] = $field_to_calculate;
-                    if ($schema['properties'][ $field_to_calculate ]['type']) {
-                        switch ($schema['properties'][ $field_to_calculate ]['type']) {
+                    if ($schema['properties'][$field_to_calculate]['type']) {
+                        switch ($schema['properties'][$field_to_calculate]['type']) {
                             case 'boolean':
                                 $calculated_value = false;
                                 break;
@@ -1192,7 +1192,7 @@ 
      */
     public function validateContext($context)
     {
-        if (! $context) {
+        if ( ! $context) {
             $context = EEM_Base::caps_read;
         }
         $valid_contexts = EEM_Base::valid_cap_contexts();
@@ -1217,7 +1217,7 @@ 
             EEM_Base::default_where_conditions_minimum_all,
             EEM_Base::default_where_conditions_minimum_others,
         );
-        if (! $default_query_params) {
+        if ( ! $default_query_params) {
             $default_query_params = EEM_Base::default_where_conditions_all;
         }
         if (in_array(
@@ -1300,14 +1300,14 @@ 
         }
         if (isset($query_params['limit'])) {
             // limit should be either a string like '23' or '23,43', or an array with two items in it
-            if (! is_array($query_params['limit'])) {
+            if ( ! is_array($query_params['limit'])) {
                 $limit_array = explode(',', (string) $query_params['limit']);
             } else {
                 $limit_array = $query_params['limit'];
             }
             $sanitized_limit = array();
             foreach ($limit_array as $key => $limit_part) {
-                if ($this->debug_mode && (! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
+                if ($this->debug_mode && ( ! is_numeric($limit_part) || count($sanitized_limit) > 2)) {
                     throw new EE_Error(
                         sprintf(
                             __(
@@ -1339,7 +1339,7 @@ 
         // if this is a model protected by a password on another model, exclude the password protected
         // entities by default. But if they passed in a password, try to show them all. If the password is wrong,
         // though, they'll get an error (see Read::createEntityFromWpdbResult() which calls Read::checkPassword)
-        if (! $model->hasPassword()
+        if ( ! $model->hasPassword()
             && $model->restrictedByRelatedModelPassword()
             && $model_query_params['caps'] === EEM_Base::caps_read) {
             if (empty($query_params['password'])) {
@@ -1364,9 +1364,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsKeyForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsKeyForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1384,9 +1384,9 @@ 
         $model_ready_query_params = array();
         foreach ($query_params as $key => $value) {
             if (is_array($value)) {
-                $model_ready_query_params[ $key ] = $this->prepareRestQueryParamsValuesForModels($model, $value);
+                $model_ready_query_params[$key] = $this->prepareRestQueryParamsValuesForModels($model, $value);
             } else {
-                $model_ready_query_params[ $key ] = $value;
+                $model_ready_query_params[$key] = $value;
             }
         }
         return $model_ready_query_params;
@@ -1418,17 +1418,17 @@ 
         foreach ($exploded_contents as $item) {
             $item = trim($item);
             // if no prefix was provided, so we look for items with no "." in them
-            if (! $prefix) {
+            if ( ! $prefix) {
                 // does this item have a period?
                 if (strpos($item, '.') === false) {
                     // if not, then its what we're looking for
                     $contents_with_prefix[] = $item;
                 }
-            } elseif (strpos($item, $prefix . '.') === 0) {
+            } elseif (strpos($item, $prefix.'.') === 0) {
                 // this item has the prefix and a period, grab it
                 $contents_with_prefix[] = substr(
                     $item,
-                    strpos($item, $prefix . '.') + strlen($prefix . '.')
+                    strpos($item, $prefix.'.') + strlen($prefix.'.')
                 );
             } elseif ($item === $prefix) {
                 // this item is JUST the prefix
@@ -1467,9 +1467,9 @@ 
         if ($model_name) {
             foreach ($includes as $field_to_include) {
                 $field_to_include = trim($field_to_include);
-                if (strpos($field_to_include, $model_name . '.') === 0) {
+                if (strpos($field_to_include, $model_name.'.') === 0) {
                     // found the model name at the exact start
-                    $field_sans_model_name = str_replace($model_name . '.', '', $field_to_include);
+                    $field_sans_model_name = str_replace($model_name.'.', '', $field_to_include);
                     $extracted_fields_to_include[] = $field_sans_model_name;
                 } elseif ($field_to_include == $model_name) {
                     $extracted_fields_to_include[] = '*';
@@ -1510,7 +1510,7 @@ 
         $restricted_query_params['caps'] = $context;
         $this->setDebugInfo('model query params', $restricted_query_params);
         $model_rows = $model->get_all_wpdb_results($restricted_query_params);
-        if (! empty($model_rows)) {
+        if ( ! empty($model_rows)) {
             return $this->createEntityFromWpdbResult(
                 $model,
                 reset($model_rows),
@@ -1522,7 +1522,7 @@ 
             if ($model->exists($query_params)) {
                 // you got shafted- it existed but we didn't want to tell you!
                 throw new RestException(
-                    'rest_user_cannot_' . $context,
+                    'rest_user_cannot_'.$context,
                     sprintf(
                         __('Sorry, you cannot %1$s this %2$s. Missing permissions are: %3$s', 'event_espresso'),
                         $context,
@@ -1573,11 +1573,11 @@ 
         }
         // if this entity requires a password, they better give it and it better be right!
         if ($model->hasPassword()
-            && $model_row[ $model->getPasswordField()->get_qualified_column() ] !== '') {
+            && $model_row[$model->getPasswordField()->get_qualified_column()] !== '') {
             if (empty($request['password'])) {
                 throw new RestPasswordRequiredException();
-            } elseif (!hash_equals(
-                $model_row[ $model->getPasswordField()->get_qualified_column() ],
+            } elseif ( ! hash_equals(
+                $model_row[$model->getPasswordField()->get_qualified_column()],
                 $request['password']
             )) {
                 throw new RestPasswordIncorrectException();
@@ -1588,12 +1588,12 @@ 
             $password_supplied = $request->get_param('password');
             if (empty($password_supplied)) {
                 $query_params['exclude_protected'] = true;
-                if (!$model->exists($query_params)) {
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordRequiredException();
                 }
             } else {
-                $query_params[0][ $model->modelChainAndPassword() ] = $password_supplied;
-                if (!$model->exists($query_params)) {
+                $query_params[0][$model->modelChainAndPassword()] = $password_supplied;
+                if ( ! $model->exists($query_params)) {
                     throw new RestPasswordIncorrectException();
                 }
             }

core/entities/models/JsonModelSchema.php

Indentation +234 added lines, -234 removed lines

@@ -25,255 +25,255 @@
 class JsonModelSchema
 {
 
-    /**
-     * @var EEM_Base
-     */
-    protected $model;
+	/**
+	 * @var EEM_Base
+	 */
+	protected $model;
 
-    /**
-     * @var CalculatedModelFields
-     */
-    protected $fields_calculator;
+	/**
+	 * @var CalculatedModelFields
+	 */
+	protected $fields_calculator;
 
 
-    /**
-     * JsonModelSchema constructor.
-     *
-     * @param EEM_Base              $model
-     * @param CalculatedModelFields $fields_calculator
-     */
-    public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator)
-    {
-        $this->model = $model;
-        $this->fields_calculator = $fields_calculator;
-    }
+	/**
+	 * JsonModelSchema constructor.
+	 *
+	 * @param EEM_Base              $model
+	 * @param CalculatedModelFields $fields_calculator
+	 */
+	public function __construct(EEM_Base $model, CalculatedModelFields $fields_calculator)
+	{
+		$this->model = $model;
+		$this->fields_calculator = $fields_calculator;
+	}
 
 
-    /**
-     * Return the schema for a given model from a given model.
-     *
-     * @return array
-     */
-    public function getModelSchema()
-    {
-        return $this->getModelSchemaForRelations(
-            $this->model->relation_settings(),
-            $this->getModelSchemaForFields(
-                $this->model->field_settings(),
-                $this->getInitialSchemaStructure()
-            )
-        );
-    }
+	/**
+	 * Return the schema for a given model from a given model.
+	 *
+	 * @return array
+	 */
+	public function getModelSchema()
+	{
+		return $this->getModelSchemaForRelations(
+			$this->model->relation_settings(),
+			$this->getModelSchemaForFields(
+				$this->model->field_settings(),
+				$this->getInitialSchemaStructure()
+			)
+		);
+	}
 
 
-    /**
-     * Get the schema for a given set of model fields.
-     *
-     * @param EE_Model_Field_Base[] $model_fields
-     * @param array                  $schema
-     * @return array
-     */
-    public function getModelSchemaForFields(array $model_fields, array $schema)
-    {
-        foreach ($model_fields as $field => $model_field) {
-            if (! $model_field instanceof EE_Model_Field_Base) {
-                continue;
-            }
-            $schema['properties'][ $field ] = $model_field->getSchema();
+	/**
+	 * Get the schema for a given set of model fields.
+	 *
+	 * @param EE_Model_Field_Base[] $model_fields
+	 * @param array                  $schema
+	 * @return array
+	 */
+	public function getModelSchemaForFields(array $model_fields, array $schema)
+	{
+		foreach ($model_fields as $field => $model_field) {
+			if (! $model_field instanceof EE_Model_Field_Base) {
+				continue;
+			}
+			$schema['properties'][ $field ] = $model_field->getSchema();
 
-            // if this is a primary key field add the primary key item
-            if ($model_field instanceof EE_Primary_Key_Field_Base) {
-                $schema['properties'][ $field ]['primary_key'] = true;
-                if ($model_field instanceof EE_Primary_Key_Int_Field) {
-                    $schema['properties'][ $field ]['readonly'] = true;
-                }
-            }
+			// if this is a primary key field add the primary key item
+			if ($model_field instanceof EE_Primary_Key_Field_Base) {
+				$schema['properties'][ $field ]['primary_key'] = true;
+				if ($model_field instanceof EE_Primary_Key_Int_Field) {
+					$schema['properties'][ $field ]['readonly'] = true;
+				}
+			}
 
-            // if this is a foreign key field add the foreign key item
-            if ($model_field instanceof EE_Foreign_Key_Field_Base) {
-                $schema['properties'][ $field ]['foreign_key'] = array(
-                    'description' => esc_html__(
-                        'This is a foreign key the points to the given models.',
-                        'event_espresso'
-                    ),
-                    'type'        => 'array',
-                    'enum'        => $model_field->get_model_class_names_pointed_to(),
-                );
-            }
-        }
-        return $schema;
-    }
+			// if this is a foreign key field add the foreign key item
+			if ($model_field instanceof EE_Foreign_Key_Field_Base) {
+				$schema['properties'][ $field ]['foreign_key'] = array(
+					'description' => esc_html__(
+						'This is a foreign key the points to the given models.',
+						'event_espresso'
+					),
+					'type'        => 'array',
+					'enum'        => $model_field->get_model_class_names_pointed_to(),
+				);
+			}
+		}
+		return $schema;
+	}
 
 
-    /**
-     * Get the schema for a given set of model relations
-     *
-     * @param EE_Model_Relation_Base[] $relations_on_model
-     * @param array                    $schema
-     * @return array
-     */
-    public function getModelSchemaForRelations(array $relations_on_model, array $schema)
-    {
-        foreach ($relations_on_model as $model_name => $relation) {
-            if (! $relation instanceof EE_Model_Relation_Base) {
-                continue;
-            }
-            $model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
-                ? strtolower($model_name)
-                : EEH_Inflector::pluralize_and_lower($model_name);
-            $schema['properties'][ $model_name_for_schema ] = $relation->getSchema();
-            $schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name;
+	/**
+	 * Get the schema for a given set of model relations
+	 *
+	 * @param EE_Model_Relation_Base[] $relations_on_model
+	 * @param array                    $schema
+	 * @return array
+	 */
+	public function getModelSchemaForRelations(array $relations_on_model, array $schema)
+	{
+		foreach ($relations_on_model as $model_name => $relation) {
+			if (! $relation instanceof EE_Model_Relation_Base) {
+				continue;
+			}
+			$model_name_for_schema = $relation instanceof EE_Belongs_To_Relation
+				? strtolower($model_name)
+				: EEH_Inflector::pluralize_and_lower($model_name);
+			$schema['properties'][ $model_name_for_schema ] = $relation->getSchema();
+			$schema['properties'][ $model_name_for_schema ]['relation_model'] = $model_name;
 
-            // links schema
-            $links_key = 'https://api.eventespresso.com/' . strtolower($model_name);
-            $schema['properties']['_links']['properties'][ $links_key ] = array(
-                'description' => esc_html__(
-                    'Array of objects describing the link(s) for this relation resource.',
-                    'event_espresso'
-                ),
-                'type' => 'array',
-                'readonly' => true,
-                'items' => array(
-                    'type' => 'object',
-                    'properties' => array(
-                        'href' => array(
-                            'type' => 'string',
-                            'description' => sprintf(
-                                // translators: placeholder is the model name for the relation.
-                                esc_html__(
-                                    'The link to the resource for the %s relation(s) to this entity',
-                                    'event_espresso'
-                                ),
-                                $model_name
-                            ),
-                        ),
-                        'single' => array(
-                            'type' => 'boolean',
-                            'description' => sprintf(
-                                // translators: placeholder is the model name for the relation.
-                                esc_html__(
-                                    'Whether or not there is only a single %s relation to this entity',
-                                    'event_espresso'
-                                ),
-                                $model_name
-                            ),
-                        ),
-                    ),
-                    'additionalProperties' => false
-                ),
-            );
-        }
-        return $schema;
-    }
+			// links schema
+			$links_key = 'https://api.eventespresso.com/' . strtolower($model_name);
+			$schema['properties']['_links']['properties'][ $links_key ] = array(
+				'description' => esc_html__(
+					'Array of objects describing the link(s) for this relation resource.',
+					'event_espresso'
+				),
+				'type' => 'array',
+				'readonly' => true,
+				'items' => array(
+					'type' => 'object',
+					'properties' => array(
+						'href' => array(
+							'type' => 'string',
+							'description' => sprintf(
+								// translators: placeholder is the model name for the relation.
+								esc_html__(
+									'The link to the resource for the %s relation(s) to this entity',
+									'event_espresso'
+								),
+								$model_name
+							),
+						),
+						'single' => array(
+							'type' => 'boolean',
+							'description' => sprintf(
+								// translators: placeholder is the model name for the relation.
+								esc_html__(
+									'Whether or not there is only a single %s relation to this entity',
+									'event_espresso'
+								),
+								$model_name
+							),
+						),
+					),
+					'additionalProperties' => false
+				),
+			);
+		}
+		return $schema;
+	}
 
 
-    /**
-     * Outputs the schema header for a model.
-     *
-     * @return array
-     */
-    public function getInitialSchemaStructure()
-    {
-        return array(
-            '$schema'    => 'http://json-schema.org/draft-04/schema#',
-            'title'      => $this->model->get_this_model_name(),
-            'type'       => 'object',
-            'properties' => array(
-                'link' => array(
-                    'description' => esc_html__(
-                        'Link to event on WordPress site hosting events.',
-                        'event_espresso'
-                    ),
-                    'type' => 'string',
-                    'readonly' => true,
-                ),
-                '_links' => array(
-                    'description' => esc_html__(
-                        'Various links for resources related to the entity.',
-                        'event_espresso'
-                    ),
-                    'type' => 'object',
-                    'readonly' => true,
-                    'properties' => array(
-                        'self' => array(
-                            'description' => esc_html__(
-                                'Link to this entities resource.',
-                                'event_espresso'
-                            ),
-                            'type' => 'array',
-                            'items' => array(
-                                'type' => 'object',
-                                'properties' => array(
-                                    'href' => array(
-                                        'type' => 'string',
-                                    ),
-                                ),
-                                'additionalProperties' => false
-                            ),
-                            'readonly' => true
-                        ),
-                        'collection' => array(
-                            'description' => esc_html__(
-                                'Link to this entities collection resource.',
-                                'event_espresso'
-                            ),
-                            'type' => 'array',
-                            'items' => array(
-                                'type' => 'object',
-                                'properties' => array(
-                                    'href' => array(
-                                        'type' => 'string'
-                                    ),
-                                ),
-                                'additionalProperties' => false
-                            ),
-                            'readonly' => true
-                        ),
-                    ),
-                    'additionalProperties' => false,
-                ),
-                '_calculated_fields' => array_merge(
-                    $this->fields_calculator->getJsonSchemaForModel($this->model),
-                    array(
-                        '_protected' => $this->getProtectedFieldsSchema()
-                    )
-                ),
-                '_protected' => $this->getProtectedFieldsSchema()
-            ),
-            'additionalProperties' => false,
-        );
-    }
+	/**
+	 * Outputs the schema header for a model.
+	 *
+	 * @return array
+	 */
+	public function getInitialSchemaStructure()
+	{
+		return array(
+			'$schema'    => 'http://json-schema.org/draft-04/schema#',
+			'title'      => $this->model->get_this_model_name(),
+			'type'       => 'object',
+			'properties' => array(
+				'link' => array(
+					'description' => esc_html__(
+						'Link to event on WordPress site hosting events.',
+						'event_espresso'
+					),
+					'type' => 'string',
+					'readonly' => true,
+				),
+				'_links' => array(
+					'description' => esc_html__(
+						'Various links for resources related to the entity.',
+						'event_espresso'
+					),
+					'type' => 'object',
+					'readonly' => true,
+					'properties' => array(
+						'self' => array(
+							'description' => esc_html__(
+								'Link to this entities resource.',
+								'event_espresso'
+							),
+							'type' => 'array',
+							'items' => array(
+								'type' => 'object',
+								'properties' => array(
+									'href' => array(
+										'type' => 'string',
+									),
+								),
+								'additionalProperties' => false
+							),
+							'readonly' => true
+						),
+						'collection' => array(
+							'description' => esc_html__(
+								'Link to this entities collection resource.',
+								'event_espresso'
+							),
+							'type' => 'array',
+							'items' => array(
+								'type' => 'object',
+								'properties' => array(
+									'href' => array(
+										'type' => 'string'
+									),
+								),
+								'additionalProperties' => false
+							),
+							'readonly' => true
+						),
+					),
+					'additionalProperties' => false,
+				),
+				'_calculated_fields' => array_merge(
+					$this->fields_calculator->getJsonSchemaForModel($this->model),
+					array(
+						'_protected' => $this->getProtectedFieldsSchema()
+					)
+				),
+				'_protected' => $this->getProtectedFieldsSchema()
+			),
+			'additionalProperties' => false,
+		);
+	}
 
-    /**
-     * Returns an array of JSON schema to describe the _protected property on responses
-     * @since 4.9.74.p
-     * @return array
-     */
-    protected function getProtectedFieldsSchema()
-    {
-        return array(
-            'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'),
-            'type' => 'array',
-            'items' => array(
-                'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'),
-                'type' => 'string',
-                'readonly' => true,
-            ),
-            'readonly' => true
-        );
-    }
+	/**
+	 * Returns an array of JSON schema to describe the _protected property on responses
+	 * @since 4.9.74.p
+	 * @return array
+	 */
+	protected function getProtectedFieldsSchema()
+	{
+		return array(
+			'description' => esc_html__('Array of property names whose values were replaced with their default (because they are related to a password-protected entity.)', 'event_espresso'),
+			'type' => 'array',
+			'items' => array(
+				'description' => esc_html__('Each name corresponds to a property that is protected by password for this entity and has its default value returned in the response.', 'event_espresso'),
+				'type' => 'string',
+				'readonly' => true,
+			),
+			'readonly' => true
+		);
+	}
 
 
-    /**
-     * Allows one to just use the object as a string to get the json.
-     * eg.
-     * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields);
-     * echo $json_schema; //outputs the schema as a json formatted string.
-     *
-     * @return bool|false|mixed|string
-     */
-    public function __toString()
-    {
-        return wp_json_encode($this->getModelSchema());
-    }
+	/**
+	 * Allows one to just use the object as a string to get the json.
+	 * eg.
+	 * $json_schema = new JsonModelSchema(EEM_Event::instance(), new CalculatedModelFields);
+	 * echo $json_schema; //outputs the schema as a json formatted string.
+	 *
+	 * @return bool|false|mixed|string
+	 */
+	public function __toString()
+	{
+		return wp_json_encode($this->getModelSchema());
+	}
 }

core/db_models/fields/EE_Password_Field.php

Indentation +36 added lines, -36 removed lines

@@ -12,45 +12,45 @@
  */
 class EE_Password_Field extends EE_Text_Field_Base
 {
-    /**
-     * @var array
-     */
-    protected $protected_fields;
+	/**
+	 * @var array
+	 */
+	protected $protected_fields;
 
-    /**
-     * EE_Password_Field constructor.
-     * @param $table_column
-     * @param $nicename
-     * @param $nullable
-     * @param null $default_value
-     * @param array $protected_fields
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null, $protected_fields = array())
-    {
-        $this->protected_fields = $protected_fields;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * EE_Password_Field constructor.
+	 * @param $table_column
+	 * @param $nicename
+	 * @param $nullable
+	 * @param null $default_value
+	 * @param array $protected_fields
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null, $protected_fields = array())
+	{
+		$this->protected_fields = $protected_fields;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
-    /**
-     * Returns the names of the fields on this model that this password field should protect
-     * @since 4.9.74.p
-     * @return array
-     */
-    public function protectedFields()
-    {
-        return $this->protected_fields;
-    }
+	/**
+	 * Returns the names of the fields on this model that this password field should protect
+	 * @since 4.9.74.p
+	 * @return array
+	 */
+	public function protectedFields()
+	{
+		return $this->protected_fields;
+	}
 
-    /**
-     * Returns whether or not the specified field is protected by this model
-     * @since 4.9.74.p
-     * @param $field_name
-     * @return bool
-     */
-    public function fieldIsProtected($field_name)
-    {
-        return in_array($field_name, $this->protectedFields(), true);
-    }
+	/**
+	 * Returns whether or not the specified field is protected by this model
+	 * @since 4.9.74.p
+	 * @param $field_name
+	 * @return bool
+	 */
+	public function fieldIsProtected($field_name)
+	{
+		return in_array($field_name, $this->protectedFields(), true);
+	}
 }
 // End of file EE_Password_Field.php
 // Location: ${NAMESPACE}/EE_Password_Field.php

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +698 added lines, -698 removed lines

@@ -28,704 +28,704 @@
  */
 class RestIncomingQueryParamMetadata
 {
-    private $query_param_key;
-    private $query_param_value;
-    /**
-     * @var RestIncomingQueryParamContext
-     */
-    private $context;
-
-    /**
-     * @var EE_Model_Field_Base|null
-     */
-    private $field;
-
-    /**
-     * @var string same as $query_param_key but has the * and anything after it removed
-     */
-    private $query_param_key_sans_stars;
-
-    /**
-     * @var string for timezone or timezone offset
-     */
-    private $timezone;
-
-    /**
-     * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
-     */
-    private $is_gmt_field = false;
-
-    /**
-     * RestIncomingQueryParamMetadata constructor.
-     * You probably want to call
-     * @param string $query_param_key
-     * @param string $query_param_value
-     * @param RestIncomingQueryParamContext $context
-     */
-    public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
-    {
-        $this->query_param_key = $query_param_key;
-        $this->query_param_value = $query_param_value;
-        $this->context = $context;
-        $this->determineFieldAndTimezone();
-    }
-
-    /**
-     * Gets the query parameter key. This may have been modified (see setQueryParamValue())
-     * @return string
-     */
-    public function getQueryParamKey()
-    {
-        return $this->query_param_key;
-    }
-
-    /**
-     * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
-     * query parameters into the legacy structure)
-     * @param string|array|int|float $query_param_value
-     */
-    private function setQueryParamValue($query_param_value)
-    {
-        $this->query_param_value = $query_param_value;
-    }
-
-    /**
-     * Gets the original query parameter value passed in.
-     * @return string
-     */
-    public function getQueryParamValue()
-    {
-        return $this->query_param_value;
-    }
-
-    /**
-     * Gets the context object.
-     * @return RestIncomingQueryParamContext
-     */
-    public function getContext()
-    {
-        return $this->context;
-    }
-
-    /**
-     * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
-     * @param string $query_param_key
-     */
-    private function setQueryParamKey($query_param_key)
-    {
-        $this->query_param_key = $query_param_key;
-    }
-
-    /**
-     * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
-     * did not indicate a field, eg if it were `OR`).
-     * @return EE_Model_Field_Base|null
-     */
-    public function getField()
-    {
-        return $this->field;
-    }
-
-    /**
-     * Gets the query parameter key (with the star and everything afterwards removed).
-     * @return string
-     */
-    public function getQueryParamKeySansStars()
-    {
-        return $this->query_param_key_sans_stars;
-    }
-
-    /**
-     * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
-     * @return string
-     */
-    public function getTimezone()
-    {
-        return $this->timezone;
-    }
-
-    /**
-     * Returns whether or not this is a GMT field
-     * @return boolean
-     */
-    public function isGmtField()
-    {
-        return $this->is_gmt_field;
-    }
-
-    /**
-     * Sets the field indicated by the query parameter key (might be null).
-     * @param EE_Model_Field_Base|null $field
-     */
-    private function setField(EE_Model_Field_Base $field = null)
-    {
-        $this->field = $field;
-    }
-
-    /**
-     * Sets the query parameter key-with-stars-removed.
-     * @param string $query_param_key_sans_stars
-     */
-    private function setQueryParamKeySansStars($query_param_key_sans_stars)
-    {
-        $this->query_param_key_sans_stars = $query_param_key_sans_stars;
-    }
-
-    /**
-     * Sets the timezone (this could be a timezeon offset string).
-     * @param string $timezone
-     */
-    private function setTimezone($timezone)
-    {
-        $this->timezone = $timezone;
-    }
-
-    /**
-     * @param mixed $is_gmt_field
-     */
-    private function setIsGmtField($is_gmt_field)
-    {
-        $this->is_gmt_field = $is_gmt_field;
-    }
-
-    /**
-     * Determines what field, query param name, and query param name without stars, and timezone to use.
-     * @since 4.9.72.p
-     * @type EE_Model_Field_Base $field
-     * @return void {
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    private function determineFieldAndTimezone()
-    {
-        $this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $this->getQueryParamKey()
-        ));
-        $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-            $this->getQueryParamKeySansStars(),
-            $this->getContext()->getModel()
-        ));
-        // double-check is it a *_gmt field?
-        if (!$this->getField() instanceof EE_Model_Field_Base
-            && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
-        ) {
-            // yep, take off '_gmt', and find the field
-            $this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
-            $this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
-                $this->getQueryParamKey(),
-                $this->context->getModel()
-            ));
-            $this->setTimezone('UTC');
-            $this->setIsGmtField(true);
-        } elseif ($this->getField() instanceof EE_Datetime_Field) {
-            // so it's not a GMT field. Set the timezone on the model to the default
-            $this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
-        } else {
-            // just keep using what's already set for the timezone
-            $this->setTimezone($this->context->getModel()->get_timezone());
-        }
-        $this->assertOnlyAdminCanReadPasswordFields();
-    }
-
-    /**
-     * Throws an exception if a non-admin is trying to query by password.
-     * @since 4.9.74.p
-     * @throws RestException
-     */
-    private function assertOnlyAdminCanReadPasswordFields()
-    {
-        if ($this->getField() instanceof EE_Password_Field
-            && ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())) {
-            // only full admins can query by password. sorry bub!
-            throw new RestException(
-                'only_admins_can_query_by_password',
-                // @codingStandardsIgnoreStart
-                esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
-                // @codingStandardsIgnoreEnd
-                array(
-                    'status' => 403
-                )
-            );
-        }
-    }
-
-    /**
-     * Given a ton of input, determines the value to use for the models.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws DomainException
-     */
-    public function determineConditionsQueryParameterValue()
-    {
-        if ($this->valueIsArrayDuringRead()) {
-            return $this->determineModelValueGivenRestInputArray();
-        }
-        return ModelDataTranslator::prepareFieldValueFromJson(
-            $this->getField(),
-            $this->getQueryParamValue(),
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
-     * @since 4.9.72.p
-     * @return array|null
-     * @throws RestException
-     */
-    private function determineModelValueGivenRestInputArray()
-    {
-        $this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
-        // did they specify an operator?
-        if ($this->valueIsLegacySpecifiedOperator()) {
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_key = $query_param_value[0];
-            $translated_value = array($sub_array_key);
-            if ($this->operatorIsNAry($sub_array_key)) {
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } elseif ($this->operatorIsTernary($sub_array_key)) {
-                $translated_value[] = array(
-                    $this->prepareValuesFromJson($query_param_value[1][0]),
-                    $this->prepareValuesFromJson($query_param_value[1][1])
-                );
-            } elseif ($this->operatorIsLike($sub_array_key)) {
-                // we want to leave this value mostly-as-is (eg don't force it to be a float
-                // or a boolean or an enum value. Leave it as-is with wildcards etc)
-                // but do verify it at least doesn't have any serialized data
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
-                $translated_value[] = $query_param_value[1];
-            } elseif ($this->operatorIsUnary($sub_array_key)) {
-                // no arguments should have been provided, so don't look for any
-            } elseif ($this->operatorisBinary($sub_array_key)) {
-                // it's a valid operator, but none of the exceptions. Treat it normally.
-                $translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
-            } else {
-                // so they provided a valid operator, but wrong number of arguments
-                $this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
-                $translated_value = null;
-            }
-        } else {
-            // so they didn't provide a valid operator
-            // if we aren't in debug mode, then just try our best to fulfill the user's request
-            $this->throwInvalidOperatorExceptionIfDebugging();
-            $translated_value = null;
-        }
-        return $translated_value;
-    }
-
-    /**
-     * Returns if this request is a "read" request and the value provided was an array.
-     * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsArrayDuringRead()
-    {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
-    }
-
-    /**
-     * Returns if the value provided was an associative array (we should have already verified it's an array of some
-     * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsAssociativeArray()
-    {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
-    }
-
-    /**
-     * Checks if the array value is itself an array that fits into the simplified specified operator structure
-     * (eg `array('!=' => 123)`).
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsSimplifiedSpecifiedOperator()
-    {
-        return count($this->getQueryParamValue()) === 1
-            && array_key_exists(
-                key($this->getQueryParamValue()),
-                $this->getContext()->getModel()->valid_operators()
-            );
-    }
-
-    /**
-     * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
-     * of either comma-separated-values, or a JSON array.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @param $sub_array_value
-     * @throws RestException
-     */
-    private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
-    {
-        if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'csv_or_json_string_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
-                        'event_espresso'
-                    ),
-                    $sub_array_key
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Determines if the sub-array key is an operator taking 3 or more operators.
-     * @since 4.9.72.p
-     * @param $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsNonBinaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            array_merge(
-                $this->getContext()->getModel()->valid_in_style_operators(),
-                $this->getContext()->getModel()->valid_between_style_operators()
-            )
-        );
-    }
-
-    /**
-     * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
-     * @since 4.9.72.p
-     * @param string $sub_array_key
-     * @return boolean
-     */
-    private function subArrayKeyIsUnaryOperator($sub_array_key)
-    {
-        return array_key_exists(
-            $sub_array_key,
-            $this->getContext()->getModel()->valid_null_style_operators()
-        );
-    }
-
-    /**
-     * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
-     * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
-     * @since 4.9.72.p
-     * @param $sub_array_value
-     * @return array|mixed|object
-     */
-    private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-    {
-        // the value should be JSON or CSV
-        $values = json_decode($sub_array_value);
-        if (!is_array($values)) {
-            $values = array_filter(
-                array_map(
-                    'trim',
-                    explode(
-                        ',',
-                        $sub_array_value
-                    )
-                )
-            );
-        }
-        return $values;
-    }
-
-    /**
-     * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function assertSimplifiedSpecifiedOperator()
-    {
-        if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'numerically_indexed_array_of_values_only',
-                sprintf(
-                    /* translators: 1: variable name*/
-                    esc_html__(
-                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
-    {
-        if ($this->valueIsAssociativeArray()) {
-            $this->assertSimplifiedSpecifiedOperator();
-            $query_param_value = $this->getQueryParamValue();
-            $sub_array_value = reset($query_param_value);
-            $sub_array_key = key($query_param_value);
-            $this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
-            // they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
-            if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array(
-                    $sub_array_key,
-                    $this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
-                ));
-            } elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
-                $this->setQueryParamValue(array($sub_array_key));
-            } else {
-                $this->setQueryParamValue(array($sub_array_key, $sub_array_value));
-            }
-        }
-    }
-
-    /**
-     * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function valueIsLegacySpecifiedOperator()
-    {
-        $valid_operators = $this->getContext()->getModel()->valid_operators();
-        $query_param_value = $this->getQueryParamValue();
-        return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
-    }
-
-    /**
-     * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsNAry($operator)
-    {
-        $valueArray = $this->getQueryParamValue();
-        return array_key_exists(
-            $operator,
-            $this->getContext()->getModel()->valid_in_style_operators()
-        )
-            && isset($valueArray[1])
-            && is_array($valueArray[1])
-            && !isset($valueArray[2]);
-    }
-
-    /**
-     * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
-     * So we're looking for a value that looks like
-     * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsTernary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
-            && isset($query_param_value[1])
-            && is_array($query_param_value[1])
-            && isset($query_param_value[1][0], $query_param_value[1][1])
-            && !isset($query_param_value[1][2])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsLike($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
-            && isset($query_param_value[1])
-            && !isset($query_param_value[2]);
-    }
-
-    /**
-     * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorIsUnary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
-    }
-
-    /**
-     * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
-     * @since 4.9.72.p
-     * @param $operator
-     * @return boolean
-     */
-    private function operatorisBinary($operator)
-    {
-        $query_param_value = $this->getQueryParamValue();
-        $model = $this->getContext()->getModel();
-        return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
-                $operator,
-                array_merge(
-                    $model->valid_in_style_operators(),
-                    $model->valid_null_style_operators(),
-                    $model->valid_like_style_operators(),
-                    $model->valid_between_style_operators()
-                )
-            );
-    }
-
-    /**
-     * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
-     * @since 4.9.72.p
-     * @param $operator
-     * @throws RestException
-     */
-    private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
-    {
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'wrong_number_of_arguments',
-                sprintf(
-                    esc_html__(
-                        'The operator you provided, "%1$s" had the wrong number of arguments',
-                        'event_espresso'
-                    ),
-                    $operator
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
-     * @since 4.9.72.p
-     * @param $value
-     * @return mixed
-     * @throws RestException
-     */
-    private function prepareValuesFromJson($value)
-    {
-        return ModelDataTranslator::prepareFieldValuesFromJson(
-            $this->getField(),
-            $value,
-            $this->getContext()->getRequestedVersion(),
-            $this->getTimezone()
-        );
-    }
-
-    /**
-     * Throws an exception if an invalid operator was specified and we're debugging.
-     * @since 4.9.72.p
-     * @throws RestException
-     */
-    private function throwInvalidOperatorExceptionIfDebugging()
-    {
-        // so they didn't provide a valid operator
-        if (EED_Core_Rest_Api::debugMode()) {
-            throw new RestException(
-                'invalid_operator',
-                sprintf(
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey(),
-                    $this->getQueryParamValue()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-    }
-
-    /**
-     * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
-     * @since 4.9.72.p
-     * @return boolean
-     */
-    private function isLogicQueryParam()
-    {
-        return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
-    }
-
-
-    /**
-     * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
-     * @since 4.9.72.p
-     * @return array
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws RestException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    public function determineNestedConditionQueryParameters()
-    {
-
-        // so this param doesn't correspond to a field eh?
-        if ($this->getContext()->isWriting()) {
-            // always tell API clients about invalid parameters when they're creating data. Otherwise,
-            // they are probably going to create invalid data
-            throw new RestException(
-                'invalid_field',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                    $this->getQueryParamKey()
-                )
-            );
-        }
-        // so it's not for a field, is it a logic query param key?
-        if ($this->isLogicQueryParam()) {
-            return ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                $this->getQueryParamValue(),
-                $this->getContext()->getModel(),
-                $this->getContext()->getRequestedVersion()
-            );
-        }
-        if (EED_Core_Rest_Api::debugMode()) {
-            // only tell API clients they got it wrong if we're in debug mode
-            // otherwise try our best ot fulfill their request by ignoring this invalid data
-            throw new RestException(
-                'invalid_parameter',
-                sprintf(
-                    /* translators: 1: variable name */
-                    esc_html__(
-                        'You provided an invalid parameter, with key "%1$s"',
-                        'event_espresso'
-                    ),
-                    $this->getQueryParamKey()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        return null;
-    }
+	private $query_param_key;
+	private $query_param_value;
+	/**
+	 * @var RestIncomingQueryParamContext
+	 */
+	private $context;
+
+	/**
+	 * @var EE_Model_Field_Base|null
+	 */
+	private $field;
+
+	/**
+	 * @var string same as $query_param_key but has the * and anything after it removed
+	 */
+	private $query_param_key_sans_stars;
+
+	/**
+	 * @var string for timezone or timezone offset
+	 */
+	private $timezone;
+
+	/**
+	 * @var boolean if the field in $query_param_key is for a GMT field (eg `EVT_modified_gmt`)
+	 */
+	private $is_gmt_field = false;
+
+	/**
+	 * RestIncomingQueryParamMetadata constructor.
+	 * You probably want to call
+	 * @param string $query_param_key
+	 * @param string $query_param_value
+	 * @param RestIncomingQueryParamContext $context
+	 */
+	public function __construct($query_param_key, $query_param_value, RestIncomingQueryParamContext $context)
+	{
+		$this->query_param_key = $query_param_key;
+		$this->query_param_value = $query_param_value;
+		$this->context = $context;
+		$this->determineFieldAndTimezone();
+	}
+
+	/**
+	 * Gets the query parameter key. This may have been modified (see setQueryParamValue())
+	 * @return string
+	 */
+	public function getQueryParamKey()
+	{
+		return $this->query_param_key;
+	}
+
+	/**
+	 * Modifies the query parameter key passed in (Eg this is done when rewriting the simplified specified operator REST
+	 * query parameters into the legacy structure)
+	 * @param string|array|int|float $query_param_value
+	 */
+	private function setQueryParamValue($query_param_value)
+	{
+		$this->query_param_value = $query_param_value;
+	}
+
+	/**
+	 * Gets the original query parameter value passed in.
+	 * @return string
+	 */
+	public function getQueryParamValue()
+	{
+		return $this->query_param_value;
+	}
+
+	/**
+	 * Gets the context object.
+	 * @return RestIncomingQueryParamContext
+	 */
+	public function getContext()
+	{
+		return $this->context;
+	}
+
+	/**
+	 * Sets the query parameter key. This may be used to rewrite a key into its non-GMT alternative.
+	 * @param string $query_param_key
+	 */
+	private function setQueryParamKey($query_param_key)
+	{
+		$this->query_param_key = $query_param_key;
+	}
+
+	/**
+	 * Gets the field the query parameter key indicated. This may be null (in cases where the query parameter key
+	 * did not indicate a field, eg if it were `OR`).
+	 * @return EE_Model_Field_Base|null
+	 */
+	public function getField()
+	{
+		return $this->field;
+	}
+
+	/**
+	 * Gets the query parameter key (with the star and everything afterwards removed).
+	 * @return string
+	 */
+	public function getQueryParamKeySansStars()
+	{
+		return $this->query_param_key_sans_stars;
+	}
+
+	/**
+	 * Gets the timezone associated with this model (the site timezone, except for GMT datetime fields).
+	 * @return string
+	 */
+	public function getTimezone()
+	{
+		return $this->timezone;
+	}
+
+	/**
+	 * Returns whether or not this is a GMT field
+	 * @return boolean
+	 */
+	public function isGmtField()
+	{
+		return $this->is_gmt_field;
+	}
+
+	/**
+	 * Sets the field indicated by the query parameter key (might be null).
+	 * @param EE_Model_Field_Base|null $field
+	 */
+	private function setField(EE_Model_Field_Base $field = null)
+	{
+		$this->field = $field;
+	}
+
+	/**
+	 * Sets the query parameter key-with-stars-removed.
+	 * @param string $query_param_key_sans_stars
+	 */
+	private function setQueryParamKeySansStars($query_param_key_sans_stars)
+	{
+		$this->query_param_key_sans_stars = $query_param_key_sans_stars;
+	}
+
+	/**
+	 * Sets the timezone (this could be a timezeon offset string).
+	 * @param string $timezone
+	 */
+	private function setTimezone($timezone)
+	{
+		$this->timezone = $timezone;
+	}
+
+	/**
+	 * @param mixed $is_gmt_field
+	 */
+	private function setIsGmtField($is_gmt_field)
+	{
+		$this->is_gmt_field = $is_gmt_field;
+	}
+
+	/**
+	 * Determines what field, query param name, and query param name without stars, and timezone to use.
+	 * @since 4.9.72.p
+	 * @type EE_Model_Field_Base $field
+	 * @return void {
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	private function determineFieldAndTimezone()
+	{
+		$this->setQueryParamKeySansStars(ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$this->getQueryParamKey()
+		));
+		$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+			$this->getQueryParamKeySansStars(),
+			$this->getContext()->getModel()
+		));
+		// double-check is it a *_gmt field?
+		if (!$this->getField() instanceof EE_Model_Field_Base
+			&& ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
+		) {
+			// yep, take off '_gmt', and find the field
+			$this->setQueryParamKey(ModelDataTranslator::removeGmtFromFieldName($this->getQueryParamKeySansStars()));
+			$this->setField(ModelDataTranslator::deduceFieldFromQueryParam(
+				$this->getQueryParamKey(),
+				$this->context->getModel()
+			));
+			$this->setTimezone('UTC');
+			$this->setIsGmtField(true);
+		} elseif ($this->getField() instanceof EE_Datetime_Field) {
+			// so it's not a GMT field. Set the timezone on the model to the default
+			$this->setTimezone(EEH_DTT_Helper::get_valid_timezone_string());
+		} else {
+			// just keep using what's already set for the timezone
+			$this->setTimezone($this->context->getModel()->get_timezone());
+		}
+		$this->assertOnlyAdminCanReadPasswordFields();
+	}
+
+	/**
+	 * Throws an exception if a non-admin is trying to query by password.
+	 * @since 4.9.74.p
+	 * @throws RestException
+	 */
+	private function assertOnlyAdminCanReadPasswordFields()
+	{
+		if ($this->getField() instanceof EE_Password_Field
+			&& ! current_user_can(EE_Restriction_Generator_Base::get_default_restrictions_cap())) {
+			// only full admins can query by password. sorry bub!
+			throw new RestException(
+				'only_admins_can_query_by_password',
+				// @codingStandardsIgnoreStart
+				esc_html__('You attempted to filter by a password field without the needed privileges. Only a full admin is allowed to do that.', 'event_espresso'),
+				// @codingStandardsIgnoreEnd
+				array(
+					'status' => 403
+				)
+			);
+		}
+	}
+
+	/**
+	 * Given a ton of input, determines the value to use for the models.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws DomainException
+	 */
+	public function determineConditionsQueryParameterValue()
+	{
+		if ($this->valueIsArrayDuringRead()) {
+			return $this->determineModelValueGivenRestInputArray();
+		}
+		return ModelDataTranslator::prepareFieldValueFromJson(
+			$this->getField(),
+			$this->getQueryParamValue(),
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Given that the array value provided was itself an array, handles finding the correct value to pass to the model.
+	 * @since 4.9.72.p
+	 * @return array|null
+	 * @throws RestException
+	 */
+	private function determineModelValueGivenRestInputArray()
+	{
+		$this->transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax();
+		// did they specify an operator?
+		if ($this->valueIsLegacySpecifiedOperator()) {
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_key = $query_param_value[0];
+			$translated_value = array($sub_array_key);
+			if ($this->operatorIsNAry($sub_array_key)) {
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} elseif ($this->operatorIsTernary($sub_array_key)) {
+				$translated_value[] = array(
+					$this->prepareValuesFromJson($query_param_value[1][0]),
+					$this->prepareValuesFromJson($query_param_value[1][1])
+				);
+			} elseif ($this->operatorIsLike($sub_array_key)) {
+				// we want to leave this value mostly-as-is (eg don't force it to be a float
+				// or a boolean or an enum value. Leave it as-is with wildcards etc)
+				// but do verify it at least doesn't have any serialized data
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
+				$translated_value[] = $query_param_value[1];
+			} elseif ($this->operatorIsUnary($sub_array_key)) {
+				// no arguments should have been provided, so don't look for any
+			} elseif ($this->operatorisBinary($sub_array_key)) {
+				// it's a valid operator, but none of the exceptions. Treat it normally.
+				$translated_value[] = $this->prepareValuesFromJson($query_param_value[1]);
+			} else {
+				// so they provided a valid operator, but wrong number of arguments
+				$this->throwWrongNumberOfArgsExceptionIfDebugging($sub_array_key);
+				$translated_value = null;
+			}
+		} else {
+			// so they didn't provide a valid operator
+			// if we aren't in debug mode, then just try our best to fulfill the user's request
+			$this->throwInvalidOperatorExceptionIfDebugging();
+			$translated_value = null;
+		}
+		return $translated_value;
+	}
+
+	/**
+	 * Returns if this request is a "read" request and the value provided was an array.
+	 * This will indicate is such things as `array('<', 123)` and `array('IN', array(1,2,3))` are acceptable or not.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsArrayDuringRead()
+	{
+		return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+	}
+
+	/**
+	 * Returns if the value provided was an associative array (we should have already verified it's an array of some
+	 * sort). If the value is an associative array, it had better be in the simplified specified operator structure.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsAssociativeArray()
+	{
+		return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+	}
+
+	/**
+	 * Checks if the array value is itself an array that fits into the simplified specified operator structure
+	 * (eg `array('!=' => 123)`).
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsSimplifiedSpecifiedOperator()
+	{
+		return count($this->getQueryParamValue()) === 1
+			&& array_key_exists(
+				key($this->getQueryParamValue()),
+				$this->getContext()->getModel()->valid_operators()
+			);
+	}
+
+	/**
+	 * Throws an exception if the sub-value is an array (eg `array('!=' => array())`). It needs to just be a string,
+	 * of either comma-separated-values, or a JSON array.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @param $sub_array_value
+	 * @throws RestException
+	 */
+	private function assertSubValueIsntArray($sub_array_key, $sub_array_value)
+	{
+		if (is_array($sub_array_value) && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'csv_or_json_string_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The value provided for the operator "%1$s" should be comma-separated value string or a JSON array.',
+						'event_espresso'
+					),
+					$sub_array_key
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Determines if the sub-array key is an operator taking 3 or more operators.
+	 * @since 4.9.72.p
+	 * @param $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsNonBinaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			array_merge(
+				$this->getContext()->getModel()->valid_in_style_operators(),
+				$this->getContext()->getModel()->valid_between_style_operators()
+			)
+		);
+	}
+
+	/**
+	 * Given that the $sub_array_key is a string, checks if it's an operator taking only 1 argument.
+	 * @since 4.9.72.p
+	 * @param string $sub_array_key
+	 * @return boolean
+	 */
+	private function subArrayKeyIsUnaryOperator($sub_array_key)
+	{
+		return array_key_exists(
+			$sub_array_key,
+			$this->getContext()->getModel()->valid_null_style_operators()
+		);
+	}
+
+	/**
+	 * Parses the $sub_array_value string into an array (given it could either be a comma-separated-list or a JSON
+	 * array). eg `"1,2,3"` or `"[1,2,3]"` into `array(1,2,3)`.
+	 * @since 4.9.72.p
+	 * @param $sub_array_value
+	 * @return array|mixed|object
+	 */
+	private function extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+	{
+		// the value should be JSON or CSV
+		$values = json_decode($sub_array_value);
+		if (!is_array($values)) {
+			$values = array_filter(
+				array_map(
+					'trim',
+					explode(
+						',',
+						$sub_array_value
+					)
+				)
+			);
+		}
+		return $values;
+	}
+
+	/**
+	 * Throws an exception if the value isn't a simplified specified operator (only called when we expect that).
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function assertSimplifiedSpecifiedOperator()
+	{
+		if (!$this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'numerically_indexed_array_of_values_only',
+				sprintf(
+					/* translators: 1: variable name*/
+					esc_html__(
+						'The array provided for the parameter "%1$s" should be numerically indexed.',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * If query_param_value were in the simplified specific operator structure, change it into the legacy structure.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function transformSimplifiedSpecifiedOperatorSyntaxIntoStandardSyntax()
+	{
+		if ($this->valueIsAssociativeArray()) {
+			$this->assertSimplifiedSpecifiedOperator();
+			$query_param_value = $this->getQueryParamValue();
+			$sub_array_value = reset($query_param_value);
+			$sub_array_key = key($query_param_value);
+			$this->assertSubValueIsntArray($sub_array_key, $sub_array_value);
+			// they're doing something like "&where[EVT_ID][IN]=1,2,3" or "&where[EVT_ID][>]=5"
+			if ($this->subArrayKeyIsNonBinaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array(
+					$sub_array_key,
+					$this->extractQuickStyleSpecifiedOperatorValue($sub_array_value)
+				));
+			} elseif ($this->subArrayKeyIsUnaryOperator($sub_array_key)) {
+				$this->setQueryParamValue(array($sub_array_key));
+			} else {
+				$this->setQueryParamValue(array($sub_array_key, $sub_array_value));
+			}
+		}
+	}
+
+	/**
+	 * Returns true is the value is an array using the legacy structure to specify the operator. Eg `array('!=',123)`.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function valueIsLegacySpecifiedOperator()
+	{
+		$valid_operators = $this->getContext()->getModel()->valid_operators();
+		$query_param_value = $this->getQueryParamValue();
+		return isset($query_param_value[0])
+			&& isset($valid_operators[ $query_param_value[0] ]);
+	}
+
+	/**
+	 * Returns true if the value specified operator accepts arbitrary number of arguments, like "IN".
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsNAry($operator)
+	{
+		$valueArray = $this->getQueryParamValue();
+		return array_key_exists(
+			$operator,
+			$this->getContext()->getModel()->valid_in_style_operators()
+		)
+			&& isset($valueArray[1])
+			&& is_array($valueArray[1])
+			&& !isset($valueArray[2]);
+	}
+
+	/**
+	 * Returns true if the operator accepts 3 arguments (eg "BETWEEN").
+	 * So we're looking for a value that looks like
+	 * `array('BETWEEN', array('2015-01-01T00:00:00', '2016-01-01T00:00:00'))`.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsTernary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_between_style_operators())
+			&& isset($query_param_value[1])
+			&& is_array($query_param_value[1])
+			&& isset($query_param_value[1][0], $query_param_value[1][1])
+			&& !isset($query_param_value[1][2])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator is a similar to LIKE, indicating the value may have wildcards we should leave alone.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsLike($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_like_style_operators())
+			&& isset($query_param_value[1])
+			&& !isset($query_param_value[2]);
+	}
+
+	/**
+	 * Returns true if the operator only takes one argument (eg it's like `IS NULL`).
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorIsUnary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
+			&& !isset($query_param_value[1]);
+	}
+
+	/**
+	 * Returns true if the operator specified is a binary opeator (eg `=`, `!=`)
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @return boolean
+	 */
+	private function operatorisBinary($operator)
+	{
+		$query_param_value = $this->getQueryParamValue();
+		$model = $this->getContext()->getModel();
+		return isset($query_param_value[1])
+			&& !isset($query_param_value[2])
+			&& !array_key_exists(
+				$operator,
+				array_merge(
+					$model->valid_in_style_operators(),
+					$model->valid_null_style_operators(),
+					$model->valid_like_style_operators(),
+					$model->valid_between_style_operators()
+				)
+			);
+	}
+
+	/**
+	 * If we're debugging, throws an exception saying that the wrong number of arguments was provided.
+	 * @since 4.9.72.p
+	 * @param $operator
+	 * @throws RestException
+	 */
+	private function throwWrongNumberOfArgsExceptionIfDebugging($operator)
+	{
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'wrong_number_of_arguments',
+				sprintf(
+					esc_html__(
+						'The operator you provided, "%1$s" had the wrong number of arguments',
+						'event_espresso'
+					),
+					$operator
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Wrapper for ModelDataTranslator::prepareFieldValuesFromJson(), just a tad more DRY.
+	 * @since 4.9.72.p
+	 * @param $value
+	 * @return mixed
+	 * @throws RestException
+	 */
+	private function prepareValuesFromJson($value)
+	{
+		return ModelDataTranslator::prepareFieldValuesFromJson(
+			$this->getField(),
+			$value,
+			$this->getContext()->getRequestedVersion(),
+			$this->getTimezone()
+		);
+	}
+
+	/**
+	 * Throws an exception if an invalid operator was specified and we're debugging.
+	 * @since 4.9.72.p
+	 * @throws RestException
+	 */
+	private function throwInvalidOperatorExceptionIfDebugging()
+	{
+		// so they didn't provide a valid operator
+		if (EED_Core_Rest_Api::debugMode()) {
+			throw new RestException(
+				'invalid_operator',
+				sprintf(
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey(),
+					$this->getQueryParamValue()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+	}
+
+	/**
+	 * Returns true if the query_param_key was a logic query parameter, eg `OR`, `AND`, `NOT`, `OR*`, etc.
+	 * @since 4.9.72.p
+	 * @return boolean
+	 */
+	private function isLogicQueryParam()
+	{
+		return in_array($this->getQueryParamKeySansStars(), $this->getContext()->getModel()->logic_query_param_keys());
+	}
+
+
+	/**
+	 * If the query param isn't for a field, it must be a nested query parameter which requires different logic.
+	 * @since 4.9.72.p
+	 * @return array
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws RestException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	public function determineNestedConditionQueryParameters()
+	{
+
+		// so this param doesn't correspond to a field eh?
+		if ($this->getContext()->isWriting()) {
+			// always tell API clients about invalid parameters when they're creating data. Otherwise,
+			// they are probably going to create invalid data
+			throw new RestException(
+				'invalid_field',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+					$this->getQueryParamKey()
+				)
+			);
+		}
+		// so it's not for a field, is it a logic query param key?
+		if ($this->isLogicQueryParam()) {
+			return ModelDataTranslator::prepareConditionsQueryParamsForModels(
+				$this->getQueryParamValue(),
+				$this->getContext()->getModel(),
+				$this->getContext()->getRequestedVersion()
+			);
+		}
+		if (EED_Core_Rest_Api::debugMode()) {
+			// only tell API clients they got it wrong if we're in debug mode
+			// otherwise try our best ot fulfill their request by ignoring this invalid data
+			throw new RestException(
+				'invalid_parameter',
+				sprintf(
+					/* translators: 1: variable name */
+					esc_html__(
+						'You provided an invalid parameter, with key "%1$s"',
+						'event_espresso'
+					),
+					$this->getQueryParamKey()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		return null;
+	}
 }
 // End of file RestQueryParamMetadata.php
 // Location: EventEspresso\core\libraries\rest_api/RestQueryParamMetadata.php

core/services/database/TableManager.php

Indentation +231 added lines, -231 removed lines

@@ -13,254 +13,254 @@
 class TableManager extends \EE_Base
 {
 
-    /**
-     * @var TableAnalysis $table_analysis
-     */
-    private $table_analysis;
+	/**
+	 * @var TableAnalysis $table_analysis
+	 */
+	private $table_analysis;
 
 
-    /**
-     * TableManager constructor.
-     *
-     * @param TableAnalysis $TableAnalysis
-     */
-    public function __construct(TableAnalysis $TableAnalysis)
-    {
-        $this->table_analysis = $TableAnalysis;
-    }
+	/**
+	 * TableManager constructor.
+	 *
+	 * @param TableAnalysis $TableAnalysis
+	 */
+	public function __construct(TableAnalysis $TableAnalysis)
+	{
+		$this->table_analysis = $TableAnalysis;
+	}
 
 
-    /**
-     * Gets the injected table analyzer, or throws an exception
-     *
-     * @return TableAnalysis
-     * @throws \EE_Error
-     */
-    protected function getTableAnalysis()
-    {
-        if ($this->table_analysis instanceof TableAnalysis) {
-            return $this->table_analysis;
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
-                    get_class($this)
-                )
-            );
-        }
-    }
+	/**
+	 * Gets the injected table analyzer, or throws an exception
+	 *
+	 * @return TableAnalysis
+	 * @throws \EE_Error
+	 */
+	protected function getTableAnalysis()
+	{
+		if ($this->table_analysis instanceof TableAnalysis) {
+			return $this->table_analysis;
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Table analysis class on class %1$s is not set properly.', 'event_espresso'),
+					get_class($this)
+				)
+			);
+		}
+	}
 
 
-    /**
-     * @param string $table_name which can optionally start with $wpdb->prefix or not
-     * @param string $column_name
-     * @param string $column_info
-     * @return bool|false|int
-     */
-    public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
-    {
-        if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
-            return false;
-        }
-        global $wpdb;
-        $full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $columns = $this->getTableColumns($table_name);
-        if (! in_array($column_name, $columns)) {
-            $alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
-            return $wpdb->query($alter_query);
-        }
-        return true;
-    }
+	/**
+	 * @param string $table_name which can optionally start with $wpdb->prefix or not
+	 * @param string $column_name
+	 * @param string $column_info
+	 * @return bool|false|int
+	 */
+	public function addColumn($table_name, $column_name, $column_info = 'INT UNSIGNED NOT NULL')
+	{
+		if (apply_filters('FHEE__EEH_Activation__add_column_if_it_doesnt_exist__short_circuit', false)) {
+			return false;
+		}
+		global $wpdb;
+		$full_table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$columns = $this->getTableColumns($table_name);
+		if (! in_array($column_name, $columns)) {
+			$alter_query = "ALTER TABLE {$full_table_name} ADD {$column_name} {$column_info}";
+			return $wpdb->query($alter_query);
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets the name of all columns on the  table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return array
-     */
-    public function getTableColumns($table_name)
-    {
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $field_array = array();
-        if (! empty($table_name)) {
-            $columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
-            if ($columns !== false) {
-                foreach ($columns as $column) {
-                    $field_array[] = $column->Field;
-                }
-            }
-        }
-        return $field_array;
-    }
+	/**
+	 * Gets the name of all columns on the  table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return array
+	 */
+	public function getTableColumns($table_name)
+	{
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$field_array = array();
+		if (! empty($table_name)) {
+			$columns = $wpdb->get_results("SHOW COLUMNS FROM {$table_name} ");
+			if ($columns !== false) {
+				foreach ($columns as $column) {
+					$field_array[] = $column->Field;
+				}
+			}
+		}
+		return $field_array;
+	}
 
 
-    /**
-     * Drops the specified table from the database. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @return int
-     */
-    public function dropTable($table_name)
-    {
-        global $wpdb;
-        if ($this->getTableAnalysis()->tableExists($table_name)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified table from the database. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @return int
+	 */
+	public function dropTable($table_name)
+	{
+		global $wpdb;
+		if ($this->getTableAnalysis()->tableExists($table_name)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			return $wpdb->query("DROP TABLE IF EXISTS {$table_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Drops all the tables mentioned in a single MYSQL query. Double-checks
-     * each table name provided has a wpdb prefix attached, and that it exists.
-     * Returns the list actually deleted
-     *
-     * @global WPDB $wpdb
-     * @param array $table_names
-     * @return array of table names which we deleted
-     */
-    public function dropTables($table_names)
-    {
-        $tables_to_delete = array();
-        foreach ($table_names as $table_name) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            if ($this->getTableAnalysis()->tableExists($table_name)) {
-                $tables_to_delete[ $table_name ] = $table_name;
-            }
-        }
-        if (! empty($tables_to_delete)) {
-            global $wpdb;
-            // make sure we only have a unique strings in the array.
-            $tables_to_delete = array_unique($tables_to_delete);
-            $wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
-        }
-        return $tables_to_delete;
-    }
+	/**
+	 * Drops all the tables mentioned in a single MYSQL query. Double-checks
+	 * each table name provided has a wpdb prefix attached, and that it exists.
+	 * Returns the list actually deleted
+	 *
+	 * @global WPDB $wpdb
+	 * @param array $table_names
+	 * @return array of table names which we deleted
+	 */
+	public function dropTables($table_names)
+	{
+		$tables_to_delete = array();
+		foreach ($table_names as $table_name) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			if ($this->getTableAnalysis()->tableExists($table_name)) {
+				$tables_to_delete[ $table_name ] = $table_name;
+			}
+		}
+		if (! empty($tables_to_delete)) {
+			global $wpdb;
+			// make sure we only have a unique strings in the array.
+			$tables_to_delete = array_unique($tables_to_delete);
+			$wpdb->query('DROP TABLE ' . implode(', ', $tables_to_delete));
+		}
+		return $tables_to_delete;
+	}
 
 
-    /**
-     * Drops the specified index from the specified table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @global \wpdb $wpdb
-     * @param string $table_name
-     * @param string $index_name
-     * @return int the number of indexes dropped. False if there was a datbase error
-     */
-    public function dropIndex($table_name, $index_name)
-    {
-        if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
-            return 0;
-        }
-        global $wpdb;
-        $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-        $index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
-        if ($this->getTableAnalysis()->tableExists($table_name)
-            && $wpdb->get_var($index_exists_query)
-               === $table_name // using get_var with the $index_exists_query returns the table's name
-        ) {
-            return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
-        }
-        return 0;
-    }
+	/**
+	 * Drops the specified index from the specified table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @global \wpdb $wpdb
+	 * @param string $table_name
+	 * @param string $index_name
+	 * @return int the number of indexes dropped. False if there was a datbase error
+	 */
+	public function dropIndex($table_name, $index_name)
+	{
+		if (apply_filters('FHEE__EEH_Activation__drop_index__short_circuit', false)) {
+			return 0;
+		}
+		global $wpdb;
+		$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+		$index_exists_query = "SHOW INDEX FROM {$table_name} WHERE key_name = '{$index_name}'";
+		if ($this->getTableAnalysis()->tableExists($table_name)
+			&& $wpdb->get_var($index_exists_query)
+			   === $table_name // using get_var with the $index_exists_query returns the table's name
+		) {
+			return $wpdb->query("ALTER TABLE {$table_name} DROP INDEX {$index_name}");
+		}
+		return 0;
+	}
 
 
-    /**
-     * Just creates the requested table. $table_name can
-     * optionally start with $wpdb->prefix or not
-     *
-     * @param string $table_name
-     * @param string $create_sql defining the table's columns and indexes
-     * @param string $engine     (no need to specify "ENGINE=", that's implied)
-     * @return void
-     * @throws \EE_Error
-     */
-    public function createTable($table_name, $create_sql, $engine = 'MyISAM')
-    {
-        $engine = apply_filters(
-            'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
-            $engine,
-            $table_name,
-            $create_sql
-        );
-        // does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
-        if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
-            $table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
-            /** @var \wpdb $wpdb */
-            global $wpdb;
-            $SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
+	/**
+	 * Just creates the requested table. $table_name can
+	 * optionally start with $wpdb->prefix or not
+	 *
+	 * @param string $table_name
+	 * @param string $create_sql defining the table's columns and indexes
+	 * @param string $engine     (no need to specify "ENGINE=", that's implied)
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function createTable($table_name, $create_sql, $engine = 'MyISAM')
+	{
+		$engine = apply_filters(
+			'FHEE__EventEspresso_core_services_database_TableManager__createTable__engine',
+			$engine,
+			$table_name,
+			$create_sql
+		);
+		// does $sql contain valid column information? ( LPT: https://regex101.com/ is great for working out regex patterns )
+		if (preg_match('((((.*?))(,\s))+)', $create_sql, $valid_column_data)) {
+			$table_name = $this->getTableAnalysis()->ensureTableNameHasPrefix($table_name);
+			/** @var \wpdb $wpdb */
+			global $wpdb;
+			$SQL = "CREATE TABLE {$table_name} ( {$create_sql} ) ENGINE={$engine} " . $wpdb->get_charset_collate();
 
-            // get $wpdb to echo errors, but buffer them. This way at least WE know an error
-            // happened. And then we can choose to tell the end user
-            $old_show_errors_policy = $wpdb->show_errors(true);
-            $old_error_suppression_policy = $wpdb->suppress_errors(false);
-            ob_start();
-            dbDelta($SQL);
-            $output = ob_get_contents();
-            ob_end_clean();
-            $wpdb->show_errors($old_show_errors_policy);
-            $wpdb->suppress_errors($old_error_suppression_policy);
-            if (! empty($output)) {
-                throw new \EE_Error($output);
-            }
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
-                        'event_espresso'
-                    ),
-                    '<br />',
-                    $create_sql
-                )
-            );
-        }
-    }
+			// get $wpdb to echo errors, but buffer them. This way at least WE know an error
+			// happened. And then we can choose to tell the end user
+			$old_show_errors_policy = $wpdb->show_errors(true);
+			$old_error_suppression_policy = $wpdb->suppress_errors(false);
+			ob_start();
+			dbDelta($SQL);
+			$output = ob_get_contents();
+			ob_end_clean();
+			$wpdb->show_errors($old_show_errors_policy);
+			$wpdb->suppress_errors($old_error_suppression_policy);
+			if (! empty($output)) {
+				throw new \EE_Error($output);
+			}
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'The following table creation SQL does not contain valid information about the table columns: %1$s %2$s',
+						'event_espresso'
+					),
+					'<br />',
+					$create_sql
+				)
+			);
+		}
+	}
 
 
-    /**
-     * Drops the specified index if it's size differs from $desired_index_size.
-     * WordPress' dbdelta method doesn't automatically change index sizes, so this
-     * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
-     * If the table doesn't exist, or it exists but the index does not, or returns false
-     *
-     * @param string     $table_name
-     * @param string     $index_name
-     * @param string     $column_name        if none is provided, we assume the column name matches the index (often
-     *                                       true in EE)
-     * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
-     * @return bool whether an index was dropped or not
-     * @throws /EE_Error if table analysis object isn't defined
-     */
-    public function dropIndexIfSizeNot(
-        $table_name,
-        $index_name,
-        $column_name = null,
-        $desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
-    ) {
-        if ($column_name === null) {
-            $column_name = $index_name;
-        }
-        if (! $this->getTableAnalysis()->tableExists($table_name)) {
-            return false;
-        }
-        $index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
-        if (empty($index_entries)) {
-            return false;
-        }
-        foreach ($index_entries as $index_entry) {
-            if ($column_name === $index_entry->Column_name
-                && (string) $desired_index_size !== $index_entry->Sub_part) {
-                return $this->dropIndex($table_name, $index_name);
-            }
-        }
-        return false;
-    }
+	/**
+	 * Drops the specified index if it's size differs from $desired_index_size.
+	 * WordPress' dbdelta method doesn't automatically change index sizes, so this
+	 * method can be used to only drop the index if needed, and afterwards dbdelta can be used as normal.
+	 * If the table doesn't exist, or it exists but the index does not, or returns false
+	 *
+	 * @param string     $table_name
+	 * @param string     $index_name
+	 * @param string     $column_name        if none is provided, we assume the column name matches the index (often
+	 *                                       true in EE)
+	 * @param string|int $desired_index_size defaults to TableAnalysis::index_col_size, the max for utf8mb4.
+	 * @return bool whether an index was dropped or not
+	 * @throws /EE_Error if table analysis object isn't defined
+	 */
+	public function dropIndexIfSizeNot(
+		$table_name,
+		$index_name,
+		$column_name = null,
+		$desired_index_size = TableAnalysis::INDEX_COLUMN_SIZE
+	) {
+		if ($column_name === null) {
+			$column_name = $index_name;
+		}
+		if (! $this->getTableAnalysis()->tableExists($table_name)) {
+			return false;
+		}
+		$index_entries = $this->getTableAnalysis()->showIndexes($table_name, $index_name);
+		if (empty($index_entries)) {
+			return false;
+		}
+		foreach ($index_entries as $index_entry) {
+			if ($column_name === $index_entry->Column_name
+				&& (string) $desired_index_size !== $index_entry->Sub_part) {
+				return $this->dropIndex($table_name, $index_name);
+			}
+		}
+		return false;
+	}
 }

payment_methods/Paypal_Express/EE_PMT_Paypal_Express.pm.php

Indentation +76 added lines, -76 removed lines

@@ -15,89 +15,89 @@
 class EE_PMT_Paypal_Express extends EE_PMT_Base
 {
 
-    /**
-     * EE_PMT_Paypal_Express constructor.
-     */
-    public function __construct($pm_instance = null)
-    {
-        require_once($this->file_folder() . 'EEG_Paypal_Express.gateway.php');
-        $this->_gateway = new EEG_Paypal_Express();
+	/**
+	 * EE_PMT_Paypal_Express constructor.
+	 */
+	public function __construct($pm_instance = null)
+	{
+		require_once($this->file_folder() . 'EEG_Paypal_Express.gateway.php');
+		$this->_gateway = new EEG_Paypal_Express();
 
-        $this->_pretty_name = esc_html__('PayPal Express', 'event_espresso');
-        $this->_template_path = $this->file_folder() . 'templates' . DS;
-        $this->_default_description = esc_html__(
-            // @codingStandardsIgnoreStart
-            'After clicking \'Finalize Registration\', you will be forwarded to PayPal website to Login and make your payment.',
-            // @codingStandardsIgnoreEnd
-            'event_espresso'
-        );
-        $this->_default_button_url = $this->file_url() . 'lib' . DS . 'paypal-express-checkout-logo-gold-160.png';
+		$this->_pretty_name = esc_html__('PayPal Express', 'event_espresso');
+		$this->_template_path = $this->file_folder() . 'templates' . DS;
+		$this->_default_description = esc_html__(
+			// @codingStandardsIgnoreStart
+			'After clicking \'Finalize Registration\', you will be forwarded to PayPal website to Login and make your payment.',
+			// @codingStandardsIgnoreEnd
+			'event_espresso'
+		);
+		$this->_default_button_url = $this->file_url() . 'lib' . DS . 'paypal-express-checkout-logo-gold-160.png';
 
-        parent::__construct($pm_instance);
-    }
+		parent::__construct($pm_instance);
+	}
 
 
-    /**
-     * Adds the help tab.
-     *
-     * @see EE_PMT_Base::help_tabs_config()
-     * @return array
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                'title'    => esc_html__('PayPal Express Settings', 'event_espresso'),
-                'filename' => 'payment_methods_overview_paypal_express'
-            )
-        );
-    }
+	/**
+	 * Adds the help tab.
+	 *
+	 * @see EE_PMT_Base::help_tabs_config()
+	 * @return array
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+				'title'    => esc_html__('PayPal Express Settings', 'event_espresso'),
+				'filename' => 'payment_methods_overview_paypal_express'
+			)
+		);
+	}
 
 
-    /**
-     * Gets the form for all the settings related to this payment method type.
-     *
-     * @return EE_Payment_Method_Form
-     */
-    public function generate_new_settings_form()
-    {
-        return new SettingsForm(array(), $this->get_help_tab_link());
-    }
+	/**
+	 * Gets the form for all the settings related to this payment method type.
+	 *
+	 * @return EE_Payment_Method_Form
+	 */
+	public function generate_new_settings_form()
+	{
+		return new SettingsForm(array(), $this->get_help_tab_link());
+	}
 
 
-    /**
-     * Creates a billing form for this payment method type.
-     *
-     * @param \EE_Transaction $transaction
-     * @return \EE_Billing_Info_Form
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {
-        if ($this->_pm_instance->debug_mode()) {
-            $form = new EE_Billing_Info_Form(
-                $this->_pm_instance,
-                array(
-                    'name' => 'paypal_express_Info_Form',
-                    'subsections' => array(
-                        'paypal_express_debug_info' => new EE_Form_Section_Proper(
-                            array(
-                                'layout_strategy' => new EE_Template_Layout(
-                                    array(
-                                        'layout_template_file' => $this->_template_path
-                                                                    . 'paypal_express_debug_info.template.php',
-                                        'template_args'        => array(
-                                            'debug_mode' => $this->_pm_instance->debug_mode()
-                                        )
-                                    )
-                                )
-                            )
-                        )
-                    )
-                )
-            );
-            return $form;
-        }
+	/**
+	 * Creates a billing form for this payment method type.
+	 *
+	 * @param \EE_Transaction $transaction
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{
+		if ($this->_pm_instance->debug_mode()) {
+			$form = new EE_Billing_Info_Form(
+				$this->_pm_instance,
+				array(
+					'name' => 'paypal_express_Info_Form',
+					'subsections' => array(
+						'paypal_express_debug_info' => new EE_Form_Section_Proper(
+							array(
+								'layout_strategy' => new EE_Template_Layout(
+									array(
+										'layout_template_file' => $this->_template_path
+																	. 'paypal_express_debug_info.template.php',
+										'template_args'        => array(
+											'debug_mode' => $this->_pm_instance->debug_mode()
+										)
+									)
+								)
+							)
+						)
+					)
+				)
+			);
+			return $form;
+		}
 
-        return false;
-    }
+		return false;
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +95 added lines, -95 removed lines

@@ -11,112 +11,112 @@
 class EEM_Country extends EEM_Base
 {
 
-    // private instance of the Attendee object
-    protected static $_instance = null;
-    // array of all countries
-    private static $_all_countries = false;
-    // array of all active countries
-    private static $_active_countries = false;
+	// private instance of the Attendee object
+	protected static $_instance = null;
+	// array of all countries
+	private static $_all_countries = false;
+	// array of all active countries
+	private static $_active_countries = false;
 
 
 
-    /**
-     * Resets the country
-     * @return EEM_Country
-     */
-    public static function reset($timezone = null)
-    {
-        self::$_active_countries = null;
-        self::$_all_countries = null;
-        return parent::reset($timezone);
-    }
+	/**
+	 * Resets the country
+	 * @return EEM_Country
+	 */
+	public static function reset($timezone = null)
+	{
+		self::$_active_countries = null;
+		self::$_all_countries = null;
+		return parent::reset($timezone);
+	}
 
-    protected function __construct($timezone = null)
-    {
-        $this->singular_item = esc_html__('Country', 'event_espresso');
-        $this->plural_item = esc_html__('Countries', 'event_espresso');
+	protected function __construct($timezone = null)
+	{
+		$this->singular_item = esc_html__('Country', 'event_espresso');
+		$this->plural_item = esc_html__('Countries', 'event_espresso');
 
 
-        $this->_tables = array(
-            'Country'=> new EE_Primary_Table('esp_country', 'CNT_ISO')
-        );
-        $this->_fields = array(
-            'Country'=>array(
-                'CNT_active' => new EE_Boolean_Field('CNT_active', esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'), false, true),
-                'CNT_ISO'=> new EE_Primary_Key_String_Field('CNT_ISO', esc_html__('Country ISO Code', 'event_espresso')),
-                'CNT_ISO3'=>new EE_All_Caps_Text_Field('CNT_ISO3', esc_html__('Country ISO3 Code', 'event_espresso'), false, ''),
-                'RGN_ID'=>new EE_Integer_Field('RGN_ID', esc_html__('Region ID', 'event_espresso'), false, 0),// should be a foreign key, but no region table exists yet
-                'CNT_name'=>new EE_Plain_Text_Field('CNT_name', esc_html__('Country Name', 'event_espresso'), false, ''),
-                'CNT_cur_code'=>new EE_All_Caps_Text_Field('CNT_cur_code', esc_html__('Country Currency Code', 'event_espresso'), false),
-                'CNT_cur_single' => new EE_Plain_Text_Field('CNT_cur_single', esc_html__('Currency Name Singular', 'event_espresso'), false),
-                'CNT_cur_plural' => new EE_Plain_Text_Field('CNT_cur_plural', esc_html__('Currency Name Plural', 'event_espresso'), false),
-                'CNT_cur_sign' => new EE_Plain_Text_Field('CNT_cur_sign', esc_html__('Currency Sign', 'event_espresso'), false),
-                'CNT_cur_sign_b4' => new EE_Boolean_Field('CNT_cur_sign_b4', esc_html__('Currency Sign Before Number', 'event_espresso'), false, true),
-                'CNT_cur_dec_plc' => new EE_Integer_Field('CNT_cur_dec_plc', esc_html__('Currency Decimal Places', 'event_espresso'), false, 2),
-                'CNT_cur_dec_mrk' => new EE_Plain_Text_Field('CNT_cur_dec_mrk', esc_html__('Currency Decimal Mark', 'event_espresso'), false, '.'),
-                'CNT_cur_thsnds' => new EE_Plain_Text_Field('CNT_cur_thsnds', esc_html__('Currency Thousands Separator', 'event_espresso'), false, ','),
-                'CNT_tel_code' => new EE_Plain_Text_Field('CNT_tel_code', esc_html__('Country Telephone Code', 'event_espresso'), false, ''),
-                'CNT_is_EU' => new EE_Boolean_Field('CNT_is_EU', esc_html__('Country is Member of EU', 'event_espresso'), false, false)
-            ));
-        $this->_model_relations = array(
-            'Attendee'=>new EE_Has_Many_Relation(),
-            'State'=>new EE_Has_Many_Relation(),
-            'Venue'=>new EE_Has_Many_Relation(),
-        );
-        // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_tables = array(
+			'Country'=> new EE_Primary_Table('esp_country', 'CNT_ISO')
+		);
+		$this->_fields = array(
+			'Country'=>array(
+				'CNT_active' => new EE_Boolean_Field('CNT_active', esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'), false, true),
+				'CNT_ISO'=> new EE_Primary_Key_String_Field('CNT_ISO', esc_html__('Country ISO Code', 'event_espresso')),
+				'CNT_ISO3'=>new EE_All_Caps_Text_Field('CNT_ISO3', esc_html__('Country ISO3 Code', 'event_espresso'), false, ''),
+				'RGN_ID'=>new EE_Integer_Field('RGN_ID', esc_html__('Region ID', 'event_espresso'), false, 0),// should be a foreign key, but no region table exists yet
+				'CNT_name'=>new EE_Plain_Text_Field('CNT_name', esc_html__('Country Name', 'event_espresso'), false, ''),
+				'CNT_cur_code'=>new EE_All_Caps_Text_Field('CNT_cur_code', esc_html__('Country Currency Code', 'event_espresso'), false),
+				'CNT_cur_single' => new EE_Plain_Text_Field('CNT_cur_single', esc_html__('Currency Name Singular', 'event_espresso'), false),
+				'CNT_cur_plural' => new EE_Plain_Text_Field('CNT_cur_plural', esc_html__('Currency Name Plural', 'event_espresso'), false),
+				'CNT_cur_sign' => new EE_Plain_Text_Field('CNT_cur_sign', esc_html__('Currency Sign', 'event_espresso'), false),
+				'CNT_cur_sign_b4' => new EE_Boolean_Field('CNT_cur_sign_b4', esc_html__('Currency Sign Before Number', 'event_espresso'), false, true),
+				'CNT_cur_dec_plc' => new EE_Integer_Field('CNT_cur_dec_plc', esc_html__('Currency Decimal Places', 'event_espresso'), false, 2),
+				'CNT_cur_dec_mrk' => new EE_Plain_Text_Field('CNT_cur_dec_mrk', esc_html__('Currency Decimal Mark', 'event_espresso'), false, '.'),
+				'CNT_cur_thsnds' => new EE_Plain_Text_Field('CNT_cur_thsnds', esc_html__('Currency Thousands Separator', 'event_espresso'), false, ','),
+				'CNT_tel_code' => new EE_Plain_Text_Field('CNT_tel_code', esc_html__('Country Telephone Code', 'event_espresso'), false, ''),
+				'CNT_is_EU' => new EE_Boolean_Field('CNT_is_EU', esc_html__('Country is Member of EU', 'event_espresso'), false, false)
+			));
+		$this->_model_relations = array(
+			'Attendee'=>new EE_Has_Many_Relation(),
+			'State'=>new EE_Has_Many_Relation(),
+			'Venue'=>new EE_Has_Many_Relation(),
+		);
+		// only anyone to view, but only those with the default role can do anything
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
 
 
-    /**
-    *       _get_countries
-    *
-    *       @access     public
-    *       @return         array
-    */
-    public function get_all_countries()
-    {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(array( 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=> array( 0,99999 )));
-        }
-        return self::$_all_countries;
-    }
+	/**
+	 *       _get_countries
+	 *
+	 *       @access     public
+	 *       @return         array
+	 */
+	public function get_all_countries()
+	{
+		if (! self::$_all_countries) {
+			self::$_all_countries = $this->get_all(array( 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=> array( 0,99999 )));
+		}
+		return self::$_all_countries;
+	}
 
-    /**
-    *       _get_countries
-    *       Gets and caches the list of active countries. If you know the list of active countries
-    *       has changed during this request, first use EEM_Country::reset() to flush the cache
-    *       @access     public
-    *       @return         array
-    */
-    public function get_all_active_countries()
-    {
-        if (! self::$_active_countries) {
-            self::$_active_countries =  $this->get_all(array( array( 'CNT_active' => true ), 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=>array( 0, 99999 )));
-        }
-        return self::$_active_countries;
-    }
+	/**
+	 *       _get_countries
+	 *       Gets and caches the list of active countries. If you know the list of active countries
+	 *       has changed during this request, first use EEM_Country::reset() to flush the cache
+	 *       @access     public
+	 *       @return         array
+	 */
+	public function get_all_active_countries()
+	{
+		if (! self::$_active_countries) {
+			self::$_active_countries =  $this->get_all(array( array( 'CNT_active' => true ), 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=>array( 0, 99999 )));
+		}
+		return self::$_active_countries;
+	}
 
-    /**
-     * Gets the country's name by its ISO
-     * @param string $country_ISO
-     * @return string
-     */
-    public function get_country_name_by_ISO($country_ISO)
-    {
-        if (isset(self::$_all_countries[ $country_ISO ]) &&
-                self::$_all_countries[ $country_ISO ] instanceof EE_Country ) {
-            return self::$_all_countries[ $country_ISO ]->name();
-        }
-        $names = $this->get_col(array( array( 'CNT_ISO' => $country_ISO ), 'limit' => 1), 'CNT_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        } else {
-            return '';
-        }
-    }
+	/**
+	 * Gets the country's name by its ISO
+	 * @param string $country_ISO
+	 * @return string
+	 */
+	public function get_country_name_by_ISO($country_ISO)
+	{
+		if (isset(self::$_all_countries[ $country_ISO ]) &&
+				self::$_all_countries[ $country_ISO ] instanceof EE_Country ) {
+			return self::$_all_countries[ $country_ISO ]->name();
+		}
+		$names = $this->get_col(array( array( 'CNT_ISO' => $country_ISO ), 'limit' => 1), 'CNT_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
+			return '';
+		}
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -45,7 +45,7 @@ 
                 'CNT_active' => new EE_Boolean_Field('CNT_active', esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'), false, true),
                 'CNT_ISO'=> new EE_Primary_Key_String_Field('CNT_ISO', esc_html__('Country ISO Code', 'event_espresso')),
                 'CNT_ISO3'=>new EE_All_Caps_Text_Field('CNT_ISO3', esc_html__('Country ISO3 Code', 'event_espresso'), false, ''),
-                'RGN_ID'=>new EE_Integer_Field('RGN_ID', esc_html__('Region ID', 'event_espresso'), false, 0),// should be a foreign key, but no region table exists yet
+                'RGN_ID'=>new EE_Integer_Field('RGN_ID', esc_html__('Region ID', 'event_espresso'), false, 0), // should be a foreign key, but no region table exists yet
                 'CNT_name'=>new EE_Plain_Text_Field('CNT_name', esc_html__('Country Name', 'event_espresso'), false, ''),
                 'CNT_cur_code'=>new EE_All_Caps_Text_Field('CNT_cur_code', esc_html__('Country Currency Code', 'event_espresso'), false),
                 'CNT_cur_single' => new EE_Plain_Text_Field('CNT_cur_single', esc_html__('Currency Name Singular', 'event_espresso'), false),
@@ -64,7 +64,7 @@ 
             'Venue'=>new EE_Has_Many_Relation(),
         );
         // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+        $this->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
 
         parent::__construct($timezone);
     }
@@ -80,8 +80,8 @@ 
     */
     public function get_all_countries()
     {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(array( 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=> array( 0,99999 )));
+        if ( ! self::$_all_countries) {
+            self::$_all_countries = $this->get_all(array('order_by'=>array('CNT_name'=>'ASC'), 'limit'=> array(0, 99999)));
         }
         return self::$_all_countries;
     }
@@ -95,8 +95,8 @@ 
     */
     public function get_all_active_countries()
     {
-        if (! self::$_active_countries) {
-            self::$_active_countries =  $this->get_all(array( array( 'CNT_active' => true ), 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=>array( 0, 99999 )));
+        if ( ! self::$_active_countries) {
+            self::$_active_countries = $this->get_all(array(array('CNT_active' => true), 'order_by'=>array('CNT_name'=>'ASC'), 'limit'=>array(0, 99999)));
         }
         return self::$_active_countries;
     }
@@ -108,11 +108,11 @@ 
      */
     public function get_country_name_by_ISO($country_ISO)
     {
-        if (isset(self::$_all_countries[ $country_ISO ]) &&
-                self::$_all_countries[ $country_ISO ] instanceof EE_Country ) {
-            return self::$_all_countries[ $country_ISO ]->name();
+        if (isset(self::$_all_countries[$country_ISO]) &&
+                self::$_all_countries[$country_ISO] instanceof EE_Country) {
+            return self::$_all_countries[$country_ISO]->name();
         }
-        $names = $this->get_col(array( array( 'CNT_ISO' => $country_ISO ), 'limit' => 1), 'CNT_name');
+        $names = $this->get_col(array(array('CNT_ISO' => $country_ISO), 'limit' => 1), 'CNT_name');
         if (is_array($names) && ! empty($names)) {
             return reset($names);
         } else {

caffeinated/payment_methods/Paypal_Pro/EE_PMT_Paypal_Pro.pm.php

Indentation +146 added lines, -146 removed lines

@@ -14,150 +14,150 @@
 class EE_PMT_Paypal_Pro extends EE_PMT_Base
 {
 
-    /**
-     * @param EE_Payment_Method $pm_instance
-     * @return EE_PMT_Paypal_Pro
-     */
-    public function __construct($pm_instance = null)
-    {
-        require_once($this->file_folder().'EEG_Paypal_Pro.gateway.php');
-        $this->_gateway = new EEG_Paypal_Pro();
-        $this->_pretty_name = __("Paypal Pro", 'event_espresso');
-        $this->_default_description = __('Please provide the following billing information.', 'event_espresso');
-        $this->_requires_https = true;
-        parent::__construct($pm_instance);
-    }
-
-
-    /**
-     * Gets the form for all the settings related to this payment method type
-     * @return EE_Payment_Method_Form
-     * @throws InvalidArgumentException
-     * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
-     * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
-     */
-    public function generate_new_settings_form()
-    {
-        return new PayPalProSettingsForm(array(), $this->get_help_tab_link());
-    }
-
-
-    /**
-     * Creates the billing form for this payment method type
-     * @param \EE_Transaction $transaction
-     * @throws \EE_Error
-     * @return EE_Billing_Info_Form
-     */
-    public function generate_new_billing_form(EE_Transaction $transaction = null)
-    {
-        $allowed_types = $this->_pm_instance->get_extra_meta('credit_card_types', true);
-        // if allowed types is a string or empty array or null...
-        if (empty($allowed_types)) {
-            $allowed_types = array();
-        }
-
-        $billing_form = new EE_Billing_Attendee_Info_Form(
-            $this->_pm_instance,
-            array(
-                'name'=> 'Paypal_Pro_Billing_Form',
-            //              'html_id'=> 'ee-Paypal_Pro-billing-form',
-                'subsections'=>array(
-                    'credit_card'=>new EE_Credit_Card_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
-                    ),
-                    'credit_card_type'=>new EE_Select_Input(
-                        // the options are set dynamically
-                        array_intersect_key(EE_PMT_Paypal_Pro::card_types_supported(), array_flip($allowed_types)),
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
-                    ),
-                    'exp_month'=>new EE_Credit_Card_Month_Input(
-                        true,
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso')  )
-                    ),
-                    'exp_year'=>new EE_Credit_Card_Year_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso')  )
-                    ),
-                    'cvv'=>new EE_CVV_Input(
-                        array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso') )
-                    ),
-                )
-            )
-        );
-        return $this->apply_billing_form_debug_settings($billing_form);
-    }
-
-
-
-    /**
-     * apply_billing_form_debug_settings
-     * applies debug data to the form
-     *
-     * @param \EE_Billing_Info_Form $billing_form
-     * @return \EE_Billing_Info_Form
-     */
-    public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
-    {
-        if ($this->_pm_instance->debug_mode()) {
-            $billing_form->add_subsections(
-                array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
-                'credit_card'
-            );
-            $billing_form->add_subsections(
-                array( 'debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
-                'first_name'
-            );
-            $billing_form->get_input('credit_card_type')->set_default('Visa');
-            $billing_form->get_input('exp_year')->set_default(2018);
-            $billing_form->get_input('cvv')->set_default('115');
-        }
-        return $billing_form;
-    }
-
-
-
-    /**
-     * Returns an array of all the payment cards possibly supported by paypal pro.
-     * Keys are their values, values are their pretty names.
-     * @return array
-     */
-    public static function card_types_supported()
-    {
-        return array(
-            'Visa'=>  __("Visa", 'event_espresso'),
-            'MasterCard'=>  __("MasterCard", 'event_espresso'),
-            'Amex'=>  __("American Express", 'event_espresso'),
-            'Discover'=>  __("Discover", 'event_espresso')
-            );
-    }
-
-
-
-    /**
-     * Adds the help tab
-     * @see EE_PMT_Base::help_tabs_config()
-     * @return array
-     */
-    public function help_tabs_config()
-    {
-        return array(
-            $this->get_help_tab_name() => array(
-                        'title' => __('PayPal Pro Settings', 'event_espresso'),
-                        'filename' => 'payment_methods_overview_paypalpro'
-                        ),
-        );
-    }
-
-    /**
-     * Overrides parent's _get_billing_values_from_form because we want to
-     * get the country's 2-character ISO code, not the name like most gateways
-     * @param EE_Billing_Info_Form $billing_form
-     * @return array
-     */
-    protected function _get_billing_values_from_form($billing_form)
-    {
-        $billing_values = parent::_get_billing_values_from_form($billing_form);
-        $billing_values['country'] = $billing_form->get_input_value('country');
-        $billing_values['credit_card_type'] = $billing_form->get_input_value('credit_card_type');
-        return $billing_values;
-    }
+	/**
+	 * @param EE_Payment_Method $pm_instance
+	 * @return EE_PMT_Paypal_Pro
+	 */
+	public function __construct($pm_instance = null)
+	{
+		require_once($this->file_folder().'EEG_Paypal_Pro.gateway.php');
+		$this->_gateway = new EEG_Paypal_Pro();
+		$this->_pretty_name = __("Paypal Pro", 'event_espresso');
+		$this->_default_description = __('Please provide the following billing information.', 'event_espresso');
+		$this->_requires_https = true;
+		parent::__construct($pm_instance);
+	}
+
+
+	/**
+	 * Gets the form for all the settings related to this payment method type
+	 * @return EE_Payment_Method_Form
+	 * @throws InvalidArgumentException
+	 * @throws \EventEspresso\core\exceptions\InvalidDataTypeException
+	 * @throws \EventEspresso\core\exceptions\InvalidInterfaceException
+	 */
+	public function generate_new_settings_form()
+	{
+		return new PayPalProSettingsForm(array(), $this->get_help_tab_link());
+	}
+
+
+	/**
+	 * Creates the billing form for this payment method type
+	 * @param \EE_Transaction $transaction
+	 * @throws \EE_Error
+	 * @return EE_Billing_Info_Form
+	 */
+	public function generate_new_billing_form(EE_Transaction $transaction = null)
+	{
+		$allowed_types = $this->_pm_instance->get_extra_meta('credit_card_types', true);
+		// if allowed types is a string or empty array or null...
+		if (empty($allowed_types)) {
+			$allowed_types = array();
+		}
+
+		$billing_form = new EE_Billing_Attendee_Info_Form(
+			$this->_pm_instance,
+			array(
+				'name'=> 'Paypal_Pro_Billing_Form',
+			//              'html_id'=> 'ee-Paypal_Pro-billing-form',
+				'subsections'=>array(
+					'credit_card'=>new EE_Credit_Card_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Number', 'event_espresso'))
+					),
+					'credit_card_type'=>new EE_Select_Input(
+						// the options are set dynamically
+						array_intersect_key(EE_PMT_Paypal_Pro::card_types_supported(), array_flip($allowed_types)),
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Card Type', 'event_espresso'))
+					),
+					'exp_month'=>new EE_Credit_Card_Month_Input(
+						true,
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' =>  __('Expiry Month', 'event_espresso')  )
+					),
+					'exp_year'=>new EE_Credit_Card_Year_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('Expiry Year', 'event_espresso')  )
+					),
+					'cvv'=>new EE_CVV_Input(
+						array( 'required'=>true, 'html_class' => 'ee-billing-qstn', 'html_label_text' => __('CVV', 'event_espresso') )
+					),
+				)
+			)
+		);
+		return $this->apply_billing_form_debug_settings($billing_form);
+	}
+
+
+
+	/**
+	 * apply_billing_form_debug_settings
+	 * applies debug data to the form
+	 *
+	 * @param \EE_Billing_Info_Form $billing_form
+	 * @return \EE_Billing_Info_Form
+	 */
+	public function apply_billing_form_debug_settings(EE_Billing_Info_Form $billing_form)
+	{
+		if ($this->_pm_instance->debug_mode()) {
+			$billing_form->add_subsections(
+				array( 'fyi_about_autofill' => $billing_form->payment_fields_autofilled_notice_html() ),
+				'credit_card'
+			);
+			$billing_form->add_subsections(
+				array( 'debug_content' => new EE_Form_Section_HTML_From_Template(dirname(__FILE__).DS.'templates'.DS.'paypal_pro_debug_info.template.php')),
+				'first_name'
+			);
+			$billing_form->get_input('credit_card_type')->set_default('Visa');
+			$billing_form->get_input('exp_year')->set_default(2018);
+			$billing_form->get_input('cvv')->set_default('115');
+		}
+		return $billing_form;
+	}
+
+
+
+	/**
+	 * Returns an array of all the payment cards possibly supported by paypal pro.
+	 * Keys are their values, values are their pretty names.
+	 * @return array
+	 */
+	public static function card_types_supported()
+	{
+		return array(
+			'Visa'=>  __("Visa", 'event_espresso'),
+			'MasterCard'=>  __("MasterCard", 'event_espresso'),
+			'Amex'=>  __("American Express", 'event_espresso'),
+			'Discover'=>  __("Discover", 'event_espresso')
+			);
+	}
+
+
+
+	/**
+	 * Adds the help tab
+	 * @see EE_PMT_Base::help_tabs_config()
+	 * @return array
+	 */
+	public function help_tabs_config()
+	{
+		return array(
+			$this->get_help_tab_name() => array(
+						'title' => __('PayPal Pro Settings', 'event_espresso'),
+						'filename' => 'payment_methods_overview_paypalpro'
+						),
+		);
+	}
+
+	/**
+	 * Overrides parent's _get_billing_values_from_form because we want to
+	 * get the country's 2-character ISO code, not the name like most gateways
+	 * @param EE_Billing_Info_Form $billing_form
+	 * @return array
+	 */
+	protected function _get_billing_values_from_form($billing_form)
+	{
+		$billing_values = parent::_get_billing_values_from_form($billing_form);
+		$billing_values['country'] = $billing_form->get_input_value('country');
+		$billing_values['credit_card_type'] = $billing_form->get_input_value('credit_card_type');
+		return $billing_values;
+	}
 }