eventespresso / event-espresso-core

core/libraries/rest_api/Model_Version_Info.php

Indentation +457 added lines, -457 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -24,462 +24,462 @@ 
 class Model_Version_Info
 {
 
-    /**
-     * Constant used in the $_model_changes array to indicate that a model
-     * was completely new in this version
-     */
-    const model_added = 'model_added_in_this_version';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $_model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $_resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $_requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $_cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $_cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $_cached_fields_on_models = array();
-
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->_requested_version = $requested_version;
-        $this->_model_changes = array(
-            '4.8.29' => array(
-                //first version where the REST API is in EE core, so no need
-                //to specify how its different from the previous
-            ),
-        );
-        //setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->_resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->_resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
-                            $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function model_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            foreach ($this->model_changes() as $version => $models_changed_in_version) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $model_changes[$version] = $models_changed_in_version;
-                }
-            }
-            $this->_cached_model_changes_between_requested_version_and_current = $model_changes;
-        }
-        return $this->_cached_model_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function resource_changes_between_requested_version_and_current()
-    {
-        if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            foreach ($this->resource_changes() as $version => $model_classnames) {
-                if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
-                    $resource_changes[$version] = $model_classnames;
-                }
-            }
-            $this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
-        }
-        return $this->_cached_resource_changes_between_requested_version_and_current;
-    }
-
-
-
-    /**
-     * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
-     *
-     * @return string like '4.6'
-     */
-    public function requested_version()
-    {
-        return $this->_requested_version;
-    }
-
-
-
-    /**
-     * Returns an array describing how the models have changed in each version of core
-     * that supports the API (starting at 4.6)
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either NULL (indicating the model is completely NEW in this version),
-     * or it's an array where fields are value names.
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @return array
-     */
-    public function model_changes()
-    {
-        return $this->_model_changes;
-    }
-
-
-
-    /**
-     * Takes into account the requested version, and the current version, and
-     * what changed between the two, and tries to return.
-     * Analogous to EE_Registry::instance()->non_abstract_db_models
-     *
-     * @return array keys are model names, values are their classname
-     */
-    public function models_for_requested_version()
-    {
-        if ($this->_cached_models_for_requested_version === null) {
-            $all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
-                        unset($all_models_in_current_version[$model_name]);
-                    }
-                }
-            }
-            $this->_cached_models_for_requested_version = apply_filters(
-                'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
-                $all_models_in_current_version,
-                $this
-            );
-        }
-        return $this->_cached_models_for_requested_version;
-    }
-
-
-
-    /**
-     * Determines if this is a valid model name in the requested version.
-     * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name eg 'Event'
-     * @return boolean
-     */
-    public function is_model_name_in_this_version($model_name)
-    {
-        $model_names = $this->models_for_requested_version();
-        if (isset($model_names[$model_name])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function load_model($model_name)
-    {
-        if ($this->is_model_name_in_this_version($model_name)) {
-            return \EE_Registry::instance()->load_model($model_name);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __(
-                        'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                        'event_espresso'
-                    ),
-                    $model_name,
-                    $this->requested_version()
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param \EEM_Base $model
-     * @return array|\EE_Model_Field_Base[]
-     */
-    public function fields_on_model_in_this_version($model)
-    {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
-            //get all model changes between the requested version and current core version
-            $changes = $this->model_changes_between_requested_version_and_current();
-            //fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            //remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (
-                    isset($changes_in_version[$model->get_this_model_name()])
-                    && $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
-                ) {
-                    $current_fields = array_diff_key(
-                        $current_fields,
-                        array_flip($changes_in_version[$model->get_this_model_name()])
-                    );
-                }
-            }
-            $this->_cached_fields_on_models = $current_fields;
-        }
-        return $this->_cached_fields_on_models;
-    }
-
-
-
-    /**
-     * Determines if $object is of one of the classes of $classes. Similar to
-     * in_array(), except this checks if $object is a subclass of the classnames provided
-     * in $classnames
-     *
-     * @param object $object
-     * @param array  $classnames
-     * @return boolean
-     */
-    public function is_subclass_of_one($object, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fields_ignored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_is_ignored($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "raw" and non-raw formats.
-     * Normally the "raw" versions are only accessible to those who can edit them.
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_rendered_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_rendered_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
-    }
-
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fields_that_have_pretty_format()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function field_has_pretty_format($field_obj)
-    {
-        return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
-    }
-
-
-
-    /**
-     * Returns an array describing what extra API resource properties have been added through the versions
-     *
-     * @return array @see $this->_extra_resource_properties_for_models
-     */
-    public function resource_changes()
-    {
-        return $this->_resource_changes;
-    }
-
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extra_resource_properties_for_model($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relation_settings(\EEM_Base $model)
-    {
-        $relations = array();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->is_model_name_in_this_version($relation_name)) {
-                $relations[$relation_name] = $relation_obj;
-            }
-        }
-        //filter the results, but use the old filter name
-        return apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const model_added = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $_model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $_resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $_requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $_cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $_cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $_cached_fields_on_models = array();
+
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->_requested_version = $requested_version;
+		$this->_model_changes = array(
+			'4.8.29' => array(
+				//first version where the REST API is in EE core, so no need
+				//to specify how its different from the previous
+			),
+		);
+		//setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->_resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->_resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+							$this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function model_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			foreach ($this->model_changes() as $version => $models_changed_in_version) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$model_changes[$version] = $models_changed_in_version;
+				}
+			}
+			$this->_cached_model_changes_between_requested_version_and_current = $model_changes;
+		}
+		return $this->_cached_model_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function resource_changes_between_requested_version_and_current()
+	{
+		if ($this->_cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			foreach ($this->resource_changes() as $version => $model_classnames) {
+				if ($version <= \EED_Core_Rest_Api::core_version() && $version > $this->requested_version()) {
+					$resource_changes[$version] = $model_classnames;
+				}
+			}
+			$this->_cached_resource_changes_between_requested_version_and_current = $resource_changes;
+		}
+		return $this->_cached_resource_changes_between_requested_version_and_current;
+	}
+
+
+
+	/**
+	 * If a request was sent to 'wp-json/ee/v4.7/events' this would be '4.7'
+	 *
+	 * @return string like '4.6'
+	 */
+	public function requested_version()
+	{
+		return $this->_requested_version;
+	}
+
+
+
+	/**
+	 * Returns an array describing how the models have changed in each version of core
+	 * that supports the API (starting at 4.6)
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either NULL (indicating the model is completely NEW in this version),
+	 * or it's an array where fields are value names.
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @return array
+	 */
+	public function model_changes()
+	{
+		return $this->_model_changes;
+	}
+
+
+
+	/**
+	 * Takes into account the requested version, and the current version, and
+	 * what changed between the two, and tries to return.
+	 * Analogous to EE_Registry::instance()->non_abstract_db_models
+	 *
+	 * @return array keys are model names, values are their classname
+	 */
+	public function models_for_requested_version()
+	{
+		if ($this->_cached_models_for_requested_version === null) {
+			$all_models_in_current_version = \EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->model_changes_between_requested_version_and_current() as $version => $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === Model_Version_Info::model_added) {
+						unset($all_models_in_current_version[$model_name]);
+					}
+				}
+			}
+			$this->_cached_models_for_requested_version = apply_filters(
+				'FHEE__EventEspresso_core_libraries_rest_api__models_for_requested_version',
+				$all_models_in_current_version,
+				$this
+			);
+		}
+		return $this->_cached_models_for_requested_version;
+	}
+
+
+
+	/**
+	 * Determines if this is a valid model name in the requested version.
+	 * Similar to EE_Registry::instance()->is_model_name(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name eg 'Event'
+	 * @return boolean
+	 */
+	public function is_model_name_in_this_version($model_name)
+	{
+		$model_names = $this->models_for_requested_version();
+		if (isset($model_names[$model_name])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function load_model($model_name)
+	{
+		if ($this->is_model_name_in_this_version($model_name)) {
+			return \EE_Registry::instance()->load_model($model_name);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__(
+						'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+						'event_espresso'
+					),
+					$model_name,
+					$this->requested_version()
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param \EEM_Base $model
+	 * @return array|\EE_Model_Field_Base[]
+	 */
+	public function fields_on_model_in_this_version($model)
+	{
+		if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+			//get all model changes between the requested version and current core version
+			$changes = $this->model_changes_between_requested_version_and_current();
+			//fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			//remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (
+					isset($changes_in_version[$model->get_this_model_name()])
+					&& $changes_in_version[$model->get_this_model_name()] !== Model_Version_Info::model_added
+				) {
+					$current_fields = array_diff_key(
+						$current_fields,
+						array_flip($changes_in_version[$model->get_this_model_name()])
+					);
+				}
+			}
+			$this->_cached_fields_on_models = $current_fields;
+		}
+		return $this->_cached_fields_on_models;
+	}
+
+
+
+	/**
+	 * Determines if $object is of one of the classes of $classes. Similar to
+	 * in_array(), except this checks if $object is a subclass of the classnames provided
+	 * in $classnames
+	 *
+	 * @param object $object
+	 * @param array  $classnames
+	 * @return boolean
+	 */
+	public function is_subclass_of_one($object, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fields_ignored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array('EE_Foreign_Key_Field_Base', 'EE_Any_Foreign_Model_Name_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_is_ignored($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_ignored());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "raw" and non-raw formats.
+	 * Normally the "raw" versions are only accessible to those who can edit them.
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_rendered_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_rendered_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_rendered_format());
+	}
+
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT queryable or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fields_that_have_pretty_format()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function field_has_pretty_format($field_obj)
+	{
+		return $this->is_subclass_of_one($field_obj, $this->fields_that_have_pretty_format());
+	}
+
+
+
+	/**
+	 * Returns an array describing what extra API resource properties have been added through the versions
+	 *
+	 * @return array @see $this->_extra_resource_properties_for_models
+	 */
+	public function resource_changes()
+	{
+		return $this->_resource_changes;
+	}
+
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extra_resource_properties_for_model($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resource_changes_between_requested_version_and_current() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relation_settings(\EEM_Base $model)
+	{
+		$relations = array();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->is_model_name_in_this_version($relation_name)) {
+				$relations[$relation_name] = $relation_obj;
+			}
+		}
+		//filter the results, but use the old filter name
+		return apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 
 }
 

Spacing +3 added lines, -3 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -120,7 +120,7 @@ 
                 foreach ($extra_fields as $fieldname => $field_data) {
                     $this->_resource_changes[$model_classname][$fieldname]['name'] = $fieldname;
                     foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
+                        if ( ! isset($this->_resource_changes[$model_classname][$fieldname][$attribute])) {
                             $this->_resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
@@ -292,7 +292,7 @@ 
      */
     public function fields_on_model_in_this_version($model)
     {
-        if (! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
+        if ( ! isset($this->_cached_fields_on_models[$model->get_this_model_name()])) {
             //get all model changes between the requested version and current core version
             $changes = $this->model_changes_between_requested_version_and_current();
             //fetch all fields currently on this model

core/libraries/rest_api/Model_Data_Translator.php

Indentation +481 added lines, -481 removed lines

@@ -2,7 +2,7 @@ 
 namespace EventEspresso\core\libraries\rest_api;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -27,485 +27,485 @@ 
 class Model_Data_Translator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const ee_inf_in_rest = null;
-
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_values_from_json(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
-                    $field_obj,
-                    $array_item,
-                    $request_version
-                );
-            }
-        } else {
-            $new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws \DomainException
-     */
-    public static function prepare_field_value_from_json(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    )
-    {
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        if ($field_obj instanceof \EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
-                $field_obj->get_timezone_offset(
-                    new \DateTimeZone($timezone_string)
-                )
-            );
-            $offset_string =
-                str_pad(
-                    floor($offset_secs / HOUR_IN_SECONDS),
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                )
-                . ':'
-                . str_pad(
-                    ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                    2,
-                    '0',
-                    STR_PAD_LEFT
-                );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parse_timezone_offset($timezone_offset)
-    {
-        $first_char = substr((string)$timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @return mixed
-     */
-    public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = Model_Data_Translator::ee_inf_in_rest;
-        } elseif ($field_obj instanceof \EE_Datetime_Field) {
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } else {
-                $new_value = $original_value;
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array     $inputted_query_params_of_this_type
-     * @param \EEM_Base $model
-     * @param string    $requested_version
-     * @return array
-     * @throws \DomainException
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_models(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
-                && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
-                $field = Model_Data_Translator::deduce_field_from_query_param(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-            } else {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            }
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
-                            $requested_version, $timezone);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
-                        $requested_version, $timezone);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function is_gmt_date_field_name($field_name)
-    {
-        return substr(
-                   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
-                   -4,
-                   4
-               ) === '_gmt';
-    }
-
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function remove_gmt_from_field_name($field_name)
-    {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepare_field_name_from_json($field_name)
-    {
-        if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
-            return Model_Data_Translator::remove_gmt_from_field_name($field_name);
-        }
-        return $field_name;
-    }
-
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepare_field_names_from_json(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array     $model_query_params
-     * @param \EEM_Base $model
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws \EE_Error
-     */
-    public static function prepare_query_params_for_rest_api(
-        array $model_query_params,
-        \EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params, $model_query_params, $model, $requested_version);
-    }
-
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param \EEM_Base $model
-     * @param string    $requested_version                  eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws \EE_Error
-     */
-    public static function prepare_conditions_query_params_for_rest_api(
-        $inputted_query_params_of_this_type,
-        \EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = Model_Data_Translator::deduce_field_from_query_param(
-                Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
-                $model
-            );
-            if ($field instanceof \EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
-                            $requested_version);
-                    }
-                } else {
-                    $translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
-                        $requested_version);
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
-                    $model, $requested_version);
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param \EEM_Base $model
-     * @return \EE_Model_Field_Base
-     * @throws \EE_Error
-     */
-    public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
-    {
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
-        //which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
-                'event_espresso'), $query_param_name));
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
-        }
-        try {
-            return $model->field_settings_for($field_name);
-        } catch (\EE_Error $e) {
-            return null;
-        }
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const ee_inf_in_rest = null;
+
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_values_from_json(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_from_json(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_from_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepare_field_values_for_json($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = Model_Data_Translator::prepare_field_value_for_json(
+					$field_obj,
+					$array_item,
+					$request_version
+				);
+			}
+		} else {
+			$new_value_maybe_array = Model_Data_Translator::prepare_field_value_for_json(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws \DomainException
+	 */
+	public static function prepare_field_value_from_json(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	)
+	{
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		if ($field_obj instanceof \EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			list($offset_sign, $offset_secs) = Model_Data_Translator::parse_timezone_offset(
+				$field_obj->get_timezone_offset(
+					new \DateTimeZone($timezone_string)
+				)
+			);
+			$offset_string =
+				str_pad(
+					floor($offset_secs / HOUR_IN_SECONDS),
+					2,
+					'0',
+					STR_PAD_LEFT
+				)
+				. ':'
+				. str_pad(
+					($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+					2,
+					'0',
+					STR_PAD_LEFT
+				);
+			$new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parse_timezone_offset($timezone_offset)
+	{
+		$first_char = substr((string)$timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string)$timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @return mixed
+	 */
+	public static function prepare_field_value_for_json($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = Model_Data_Translator::ee_inf_in_rest;
+		} elseif ($field_obj instanceof \EE_Datetime_Field) {
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} else {
+				$new_value = $original_value;
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array     $inputted_query_params_of_this_type
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version
+	 * @return array
+	 * @throws \DomainException
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_models(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key);
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if (! $field instanceof \EE_Model_Field_Base
+				&& Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = Model_Data_Translator::remove_gmt_from_field_name($query_param_sans_stars);
+				$field = Model_Data_Translator::deduce_field_from_query_param(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+			} else {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			}
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_from_json($field, $value,
+							$requested_version, $timezone);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_from_json($field, $query_param_value,
+						$requested_version, $timezone);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_models($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function is_gmt_date_field_name($field_name)
+	{
+		return substr(
+				   Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name),
+				   -4,
+				   4
+			   ) === '_gmt';
+	}
+
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function remove_gmt_from_field_name($field_name)
+	{
+		if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepare_field_name_from_json($field_name)
+	{
+		if (Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+			return Model_Data_Translator::remove_gmt_from_field_name($field_name);
+		}
+		return $field_name;
+	}
+
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepare_field_names_from_json(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = Model_Data_Translator::prepare_field_name_from_json($field_name);
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepare_field_names_in_array_keys_from_json(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[Model_Data_Translator::prepare_field_name_from_json($field_name)] = $value;
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array     $model_query_params
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws \EE_Error
+	 */
+	public static function prepare_query_params_for_rest_api(
+		array $model_query_params,
+		\EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters('FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params, $model_query_params, $model, $requested_version);
+	}
+
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param \EEM_Base $model
+	 * @param string    $requested_version                  eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws \EE_Error
+	 */
+	public static function prepare_conditions_query_params_for_rest_api(
+		$inputted_query_params_of_this_type,
+		\EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = Model_Data_Translator::deduce_field_from_query_param(
+				Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($query_param_key),
+				$model
+			);
+			if ($field instanceof \EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = Model_Data_Translator::prepare_field_values_for_json($field, $value,
+							$requested_version);
+					}
+				} else {
+					$translated_value = Model_Data_Translator::prepare_field_value_for_json($field, $query_param_value,
+						$requested_version);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = Model_Data_Translator::prepare_conditions_query_params_for_rest_api($query_param_value,
+					$model, $requested_version);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function remove_stars_and_anything_after_from_condition_query_param_key($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Field_Base
+	 * @throws \EE_Error
+	 */
+	public static function deduce_field_from_query_param($query_param_name, \EEM_Base $model)
+	{
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
+		//which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new \EE_Error(sprintf(__('_extract_column_name is empty when trying to extract column and table name from %s',
+				'event_espresso'), $query_param_name));
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
+		}
+		try {
+			return $model->field_settings_for($field_name);
+		} catch (\EE_Error $e) {
+			return null;
+		}
+	}
 
 }

Spacing +6 added lines, -6 removed lines

@@ -1,7 +1,7 @@ 
 <?php
 namespace EventEspresso\core\libraries\rest_api;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -149,7 +149,7 @@ 
                     '0',
                     STR_PAD_LEFT
                 );
-            $new_value = rest_parse_date($original_value . $offset_sign . $offset_string);
+            $new_value = rest_parse_date($original_value.$offset_sign.$offset_string);
         } else {
             $new_value = $original_value;
         }
@@ -166,10 +166,10 @@ 
      */
     private static function parse_timezone_offset($timezone_offset)
     {
-        $first_char = substr((string)$timezone_offset, 0, 1);
+        $first_char = substr((string) $timezone_offset, 0, 1);
         if ($first_char === '+' || $first_char === '-') {
             $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
+            $offset_secs = substr((string) $timezone_offset, 1);
         } else {
             $offset_sign = '+';
             $offset_secs = $timezone_offset;
@@ -237,7 +237,7 @@ 
                 $model
             );
             //double-check is it a *_gmt field?
-            if (! $field instanceof \EE_Model_Field_Base
+            if ( ! $field instanceof \EE_Model_Field_Base
                 && Model_Data_Translator::is_gmt_date_field_name($query_param_sans_stars)
             ) {
                 //yep, take off '_gmt', and find the field
@@ -303,7 +303,7 @@ 
      */
     public static function remove_gmt_from_field_name($field_name)
     {
-        if (! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
+        if ( ! Model_Data_Translator::is_gmt_date_field_name($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = Model_Data_Translator::remove_stars_and_anything_after_from_condition_query_param_key($field_name);

core/libraries/rest_api/changes/Changes_In_Base.php

Indentation +64 added lines, -64 removed lines

@@ -6,78 +6,78 @@
 abstract class Changes_In_Base
 {
 
-    /**
-     * The version that these changes happened
-     *
-     * @var string
-     */
-    protected $_version = null;
+	/**
+	 * The version that these changes happened
+	 *
+	 * @var string
+	 */
+	protected $_version = null;
 
 
 
-    /**
-     * Called when an EE4 REST API request is made to an earlier version than
-     * what is indicated in this class' name.
-     * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
-     * so that regardless of what version of EE4 core is running, API clients
-     * will have a consistent response
-     *
-     * @return void
-     */
-    abstract public function set_hooks();
+	/**
+	 * Called when an EE4 REST API request is made to an earlier version than
+	 * what is indicated in this class' name.
+	 * Uses WordPress' add_filter and add_action to modify the EE4 REST API's response
+	 * so that regardless of what version of EE4 core is running, API clients
+	 * will have a consistent response
+	 *
+	 * @return void
+	 */
+	abstract public function set_hooks();
 
 
 
-    /**
-     * Returns whether or not this class' name indicates its hooks should
-     * apply when a request comes in for $requested_version. A class can use
-     * other conditions when determining whether to perform their callbacks or not,
-     * but this will typically be enough
-     *
-     * @param string $requested_version eg "4.8.33"
-     * @return boolean true: this class' name indicates its filters and actions
-     *                                  should take effect. False: this class' name indicates it shouldn't do anything
-     */
-    public function applies_to_version($requested_version)
-    {
-        if ($this->version() > $requested_version) {
-            return true;
-        }
-        return false;
-    }
+	/**
+	 * Returns whether or not this class' name indicates its hooks should
+	 * apply when a request comes in for $requested_version. A class can use
+	 * other conditions when determining whether to perform their callbacks or not,
+	 * but this will typically be enough
+	 *
+	 * @param string $requested_version eg "4.8.33"
+	 * @return boolean true: this class' name indicates its filters and actions
+	 *                                  should take effect. False: this class' name indicates it shouldn't do anything
+	 */
+	public function applies_to_version($requested_version)
+	{
+		if ($this->version() > $requested_version) {
+			return true;
+		}
+		return false;
+	}
 
 
 
-    /**
-     * Gets the EE core version when this changes were made to the rest api.
-     * Any requests to earlier versions should have modifications made to them
-     * by the callbacks of this class.
-     *
-     * @return string eg "4.8.33"
-     * @throws \EE_Error
-     */
-    public function version()
-    {
-        if ($this->_version === null) {
-            $matches = array();
-            $regex = '~Changes_In_(.*)_(.*)_(.*)$~';
-            $success = preg_match(
-                $regex,
-                get_class($this),
-                $matches
-            );
-            if (! $success) {
-                throw new \EE_Error(
-                    sprintf(
-                        __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
-                        get_class($this),
-                        $regex
-                    )
-                );
-            }
-            $this->_version = $matches[1] . '.' . $matches[2] . '.' . $matches[3];
-        }
-        return $this->_version;
-    }
+	/**
+	 * Gets the EE core version when this changes were made to the rest api.
+	 * Any requests to earlier versions should have modifications made to them
+	 * by the callbacks of this class.
+	 *
+	 * @return string eg "4.8.33"
+	 * @throws \EE_Error
+	 */
+	public function version()
+	{
+		if ($this->_version === null) {
+			$matches = array();
+			$regex = '~Changes_In_(.*)_(.*)_(.*)$~';
+			$success = preg_match(
+				$regex,
+				get_class($this),
+				$matches
+			);
+			if (! $success) {
+				throw new \EE_Error(
+					sprintf(
+						__('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
+						get_class($this),
+						$regex
+					)
+				);
+			}
+			$this->_version = $matches[1] . '.' . $matches[2] . '.' . $matches[3];
+		}
+		return $this->_version;
+	}
 }
 

Spacing +2 added lines, -2 removed lines

@@ -66,7 +66,7 @@ 
                 get_class($this),
                 $matches
             );
-            if (! $success) {
+            if ( ! $success) {
                 throw new \EE_Error(
                     sprintf(
                         __('The class %1$s was misnamed. It name should match the regex "%2$s"', 'event_espresso'),
@@ -75,7 +75,7 @@ 
                     )
                 );
             }
-            $this->_version = $matches[1] . '.' . $matches[2] . '.' . $matches[3];
+            $this->_version = $matches[1].'.'.$matches[2].'.'.$matches[3];
         }
         return $this->_version;
     }

core/libraries/rest_api/changes/Changes_In_4_8_36.php

Spacing +3 added lines, -3 removed lines

@@ -122,9 +122,9 @@
                 $headers,
                 array_flip(
                     array(
-                        Base::header_prefix_for_wp . 'Total',
-                        Base::header_prefix_for_wp . 'TotalPages',
-                        Base::header_prefix_for_wp . 'PageSize',
+                        Base::header_prefix_for_wp.'Total',
+                        Base::header_prefix_for_wp.'TotalPages',
+                        Base::header_prefix_for_wp.'PageSize',
                     )));
         }
         return $headers;

Indentation +173 added lines, -173 removed lines

@@ -14,179 +14,179 @@
 class Changes_In_4_8_36 extends Changes_In_Base
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function set_hooks()
-    {
-        //set a hook to remove the "calculate" query param
-        add_filter(
-            'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
-            array($this, 'remove_calculate_query_param'),
-            10,
-            3
-        );
-        //don't add the _calculated_fields either
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
-            array($this, 'remove_calculated_fields_from_response'),
-            10,
-            5
-        );
-        //and also don't add the count headers
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'remove_headers_new_in_this_version'),
-            10,
-            3
-        );
-        //remove the old featured_image part of the response...
-        add_filter(
-            'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
-            array($this, 'add_old_featured_image_part_of_cpt_entities'),
-            10,
-            5
-        );
-        //assuming ticket 9425's change gets pushed with 9406, we don't need to
-        //remove it from the calculated fields on older requests (because this will
-        //be the first version with calculated fields)
-        //before this, infinity was -1, now it's null
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            array($this, 'use_negative_one_for_infinity_before_this_version'),
-            10,
-            4
-        );
-    }
-
-
-
-    /**
-     * Dont show "calculate" as an query param option in the index
-     *
-     * @param array     $query_params
-     * @param \EEM_base $model
-     * @param string    $version
-     * @return array
-     */
-    public function remove_calculate_query_param($query_params, \EEM_Base $model, $version)
-    {
-        if ($this->applies_to_version($version)) {
-            unset($query_params['calculate']);
-        }
-        return $query_params;
-    }
-
-
-
-    /**
-     * Removes the "_calculate_fields" part of entity responses before 4.8.36
-     *
-     * @param array            $entity_response_array
-     * @param \EEM_Base        $model
-     * @param string           $request_context
-     * @param \WP_REST_Request $request
-     * @param Read             $controller
-     * @return array
-     */
-    public function remove_calculated_fields_from_response(
-        $entity_response_array,
-        \EEM_Base $model,
-        $request_context,
-        \WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->applies_to_version($controller->get_model_version_info()->requested_version())) {
-            unset($entity_response_array['_calculated_fields']);
-        }
-        return $entity_response_array;
-    }
-
-
-
-    /**
-     * Removes the new headers for requests before 4.8.36
-     *
-     * @param array  $headers
-     * @param Base   $controller
-     * @param string $version
-     * @return array
-     */
-    public function remove_headers_new_in_this_version(
-        $headers,
-        Controller_Base $controller,
-        $version
-    ) {
-        if ($this->applies_to_version($version)) {
-            $headers = array_diff_key(
-                $headers,
-                array_flip(
-                    array(
-                        Base::header_prefix_for_wp . 'Total',
-                        Base::header_prefix_for_wp . 'TotalPages',
-                        Base::header_prefix_for_wp . 'PageSize',
-                    )));
-        }
-        return $headers;
-    }
-
-
-
-    /**
-     * Puts the 'featured_image_url' back in for responses before 4.8.36.
-     *
-     * @param array            $entity_response_array
-     * @param \EEM_Base        $model
-     * @param string           $request_context
-     * @param \WP_REST_Request $request
-     * @param Read             $controller
-     * @return array
-     */
-    public function add_old_featured_image_part_of_cpt_entities(
-        $entity_response_array,
-        \EEM_Base $model,
-        $request_context,
-        \WP_REST_Request $request,
-        Read $controller
-    ) {
-        if ($this->applies_to_version($controller->get_model_version_info()->requested_version())
-            && $model instanceof \EEM_CPT_Base
-        ) {
-            $attachment = wp_get_attachment_image_src(
-                get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
-                'full'
-            );
-            $entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
-        }
-        return $entity_response_array;
-    }
-
-
-
-    /**
-     * If the value was infinity, we now use null in our JSON responses,
-     * but before this version we used -1.
-     *
-     * @param mixed                $new_value
-     * @param \EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_value
-     * @return mixed
-     */
-    public function use_negative_one_for_infinity_before_this_version(
-        $new_value,
-        $field_obj,
-        $original_value,
-        $requested_value
-    ) {
-        if ($this->applies_to_version($requested_value)
-            && $original_value === EE_INF
-        ) {
-            //return the old representation of infinity in the JSON
-            return -1;
-        }
-        return $new_value;
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function set_hooks()
+	{
+		//set a hook to remove the "calculate" query param
+		add_filter(
+			'FHEE__EED_Core_Rest_Api___get_response_selection_query_params',
+			array($this, 'remove_calculate_query_param'),
+			10,
+			3
+		);
+		//don't add the _calculated_fields either
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_inaccessible_field_removal',
+			array($this, 'remove_calculated_fields_from_response'),
+			10,
+			5
+		);
+		//and also don't add the count headers
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'remove_headers_new_in_this_version'),
+			10,
+			3
+		);
+		//remove the old featured_image part of the response...
+		add_filter(
+			'FHEE__Read__create_entity_from_wpdb_results__entity_before_including_requested_models',
+			array($this, 'add_old_featured_image_part_of_cpt_entities'),
+			10,
+			5
+		);
+		//assuming ticket 9425's change gets pushed with 9406, we don't need to
+		//remove it from the calculated fields on older requests (because this will
+		//be the first version with calculated fields)
+		//before this, infinity was -1, now it's null
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			array($this, 'use_negative_one_for_infinity_before_this_version'),
+			10,
+			4
+		);
+	}
+
+
+
+	/**
+	 * Dont show "calculate" as an query param option in the index
+	 *
+	 * @param array     $query_params
+	 * @param \EEM_base $model
+	 * @param string    $version
+	 * @return array
+	 */
+	public function remove_calculate_query_param($query_params, \EEM_Base $model, $version)
+	{
+		if ($this->applies_to_version($version)) {
+			unset($query_params['calculate']);
+		}
+		return $query_params;
+	}
+
+
+
+	/**
+	 * Removes the "_calculate_fields" part of entity responses before 4.8.36
+	 *
+	 * @param array            $entity_response_array
+	 * @param \EEM_Base        $model
+	 * @param string           $request_context
+	 * @param \WP_REST_Request $request
+	 * @param Read             $controller
+	 * @return array
+	 */
+	public function remove_calculated_fields_from_response(
+		$entity_response_array,
+		\EEM_Base $model,
+		$request_context,
+		\WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->applies_to_version($controller->get_model_version_info()->requested_version())) {
+			unset($entity_response_array['_calculated_fields']);
+		}
+		return $entity_response_array;
+	}
+
+
+
+	/**
+	 * Removes the new headers for requests before 4.8.36
+	 *
+	 * @param array  $headers
+	 * @param Base   $controller
+	 * @param string $version
+	 * @return array
+	 */
+	public function remove_headers_new_in_this_version(
+		$headers,
+		Controller_Base $controller,
+		$version
+	) {
+		if ($this->applies_to_version($version)) {
+			$headers = array_diff_key(
+				$headers,
+				array_flip(
+					array(
+						Base::header_prefix_for_wp . 'Total',
+						Base::header_prefix_for_wp . 'TotalPages',
+						Base::header_prefix_for_wp . 'PageSize',
+					)));
+		}
+		return $headers;
+	}
+
+
+
+	/**
+	 * Puts the 'featured_image_url' back in for responses before 4.8.36.
+	 *
+	 * @param array            $entity_response_array
+	 * @param \EEM_Base        $model
+	 * @param string           $request_context
+	 * @param \WP_REST_Request $request
+	 * @param Read             $controller
+	 * @return array
+	 */
+	public function add_old_featured_image_part_of_cpt_entities(
+		$entity_response_array,
+		\EEM_Base $model,
+		$request_context,
+		\WP_REST_Request $request,
+		Read $controller
+	) {
+		if ($this->applies_to_version($controller->get_model_version_info()->requested_version())
+			&& $model instanceof \EEM_CPT_Base
+		) {
+			$attachment = wp_get_attachment_image_src(
+				get_post_thumbnail_id($entity_response_array[$model->primary_key_name()]),
+				'full'
+			);
+			$entity_response_array['featured_image_url'] = ! empty($attachment) ? $attachment[0] : null;
+		}
+		return $entity_response_array;
+	}
+
+
+
+	/**
+	 * If the value was infinity, we now use null in our JSON responses,
+	 * but before this version we used -1.
+	 *
+	 * @param mixed                $new_value
+	 * @param \EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_value
+	 * @return mixed
+	 */
+	public function use_negative_one_for_infinity_before_this_version(
+		$new_value,
+		$field_obj,
+		$original_value,
+		$requested_value
+	) {
+		if ($this->applies_to_version($requested_value)
+			&& $original_value === EE_INF
+		) {
+			//return the old representation of infinity in the JSON
+			return -1;
+		}
+		return $new_value;
+	}
 
 }
 

core/libraries/rest_api/Rest_Exception.php

Indentation +33 added lines, -33 removed lines

@@ -12,7 +12,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -20,46 +20,46 @@ 
 class Rest_Exception extends \EE_Error
 {
 
-    /**
-     * @var array
-     */
-    protected $_wp_error_data = array();
+	/**
+	 * @var array
+	 */
+	protected $_wp_error_data = array();
 
-    protected $_wp_error_code = '';
+	protected $_wp_error_code = '';
 
 
 
-    public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
-    {
-        parent::__construct(
-            $message,
-            500,
-            $previous);
-        $this->_wp_error_data = $wp_error_data;
-        $this->_wp_error_code = $string_code;
-    }
+	public function __construct($string_code, $message, $wp_error_data = array(), $previous = null)
+	{
+		parent::__construct(
+			$message,
+			500,
+			$previous);
+		$this->_wp_error_data = $wp_error_data;
+		$this->_wp_error_code = $string_code;
+	}
 
 
 
-    /**
-     * Array of data that may have been set during the constructor, intended for WP_Error's data
-     *
-     * @return array
-     */
-    public function get_data()
-    {
-        return $this->_wp_error_data;
-    }
+	/**
+	 * Array of data that may have been set during the constructor, intended for WP_Error's data
+	 *
+	 * @return array
+	 */
+	public function get_data()
+	{
+		return $this->_wp_error_data;
+	}
 
 
 
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function get_string_code()
-    {
-        return $this->_wp_error_code;
-    }
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function get_string_code()
+	{
+		return $this->_wp_error_code;
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -11,7 +11,7 @@
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 

core/libraries/rest_api/calculations/Datetime.php

Indentation +116 added lines, -116 removed lines

@@ -14,7 +14,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,128 +22,128 @@ 
 class Datetime extends Calculations_Base
 {
 
-    /**
-     * Calculates the total spaces available on the datetime, taking into account
-     * ticket limits too.
-     *
-     * @see EE_Datetime::spaces_remaining( true )
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spaces_remaining_considering_tickets($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
-            $dtt_obj = \EEM_Datetime::instance()->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
-        } else {
-            $dtt_obj = null;
-        }
-        if ($dtt_obj instanceof \EE_Datetime) {
-            return $dtt_obj->spaces_remaining(true);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Datetime.DTT_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
+	/**
+	 * Calculates the total spaces available on the datetime, taking into account
+	 * ticket limits too.
+	 *
+	 * @see EE_Datetime::spaces_remaining( true )
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spaces_remaining_considering_tickets($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Datetime.DTT_ID'])) {
+			$dtt_obj = \EEM_Datetime::instance()->get_one_by_ID($wpdb_row['Datetime.DTT_ID']);
+		} else {
+			$dtt_obj = null;
+		}
+		if ($dtt_obj instanceof \EE_Datetime) {
+			return $dtt_obj->spaces_remaining(true);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spaces_remaining_considering_tickets because the datetime with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Datetime.DTT_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
 
 
 
-    /**
-     * Counts registrations who have checked into this datetime
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_in_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
-        return \EEM_Registration::instance()
-                                ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
-    }
+	/**
+	 * Counts registrations who have checked into this datetime
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_in_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
+		return \EEM_Registration::instance()
+								->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], true);
+	}
 
 
 
-    /**
-     * Counts registrations who have checked out of this datetime
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_out_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
-        return \EEM_Registration::instance()
-                                ->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
-    }
+	/**
+	 * Counts registrations who have checked out of this datetime
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_out_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
+		return \EEM_Registration::instance()
+								->count_registrations_checked_into_datetime($wpdb_row['Datetime.DTT_ID'], false);
+	}
 
 
 
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Controller_Base  $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
-                    'STS_ID'                 => \EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Controller_Base  $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'Ticket.Datetime.DTT_ID' => $wpdb_row['Datetime.DTT_ID'],
+					'STS_ID'                 => \EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -13,7 +13,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -68,7 +68,7 @@ 
      */
     public static function registrations_checked_in_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
@@ -96,7 +96,7 @@ 
      */
     public static function registrations_checked_out_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Datetime.DTT_ID"',
@@ -125,7 +125,7 @@ 
      */
     public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Datetime.DTT_ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Datetime.DTT_ID"',

core/libraries/rest_api/calculations/Base.php

Indentation +34 added lines, -34 removed lines

@@ -13,7 +13,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,37 +21,37 @@ 
 class Base
 {
 
-    /**
-     * @param $required_permission
-     * @param $attempted_calculation
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    protected static function _verify_current_user_can($required_permission, $attempted_calculation)
-    {
-        if (! current_user_can($required_permission)) {
-            throw new Rest_Exception(
-                'permission_denied',
-                sprintf(
-                    __('Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
-                        'event_espresso'),
-                    $attempted_calculation,
-                    \EEH_Inflector::pluralize_and_lower(self::get_resource_name()),
-                    $required_permission
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Gets the name of the resource of the called class
-     *
-     * @return string
-     */
-    public static function get_resource_name()
-    {
-        $classname = get_called_class();
-        return substr($classname, strrpos($classname, '\\') + 1);
-    }
+	/**
+	 * @param $required_permission
+	 * @param $attempted_calculation
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	protected static function _verify_current_user_can($required_permission, $attempted_calculation)
+	{
+		if (! current_user_can($required_permission)) {
+			throw new Rest_Exception(
+				'permission_denied',
+				sprintf(
+					__('Permission denied, you cannot calculate %1$s on %2$s because you do not have the capability "%3$s"',
+						'event_espresso'),
+					$attempted_calculation,
+					\EEH_Inflector::pluralize_and_lower(self::get_resource_name()),
+					$required_permission
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Gets the name of the resource of the called class
+	 *
+	 * @return string
+	 */
+	public static function get_resource_name()
+	{
+		$classname = get_called_class();
+		return substr($classname, strrpos($classname, '\\') + 1);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -28,7 +28,7 @@ 
      */
     protected static function _verify_current_user_can($required_permission, $attempted_calculation)
     {
-        if (! current_user_can($required_permission)) {
+        if ( ! current_user_can($required_permission)) {
             throw new Rest_Exception(
                 'permission_denied',
                 sprintf(

core/libraries/rest_api/calculations/Registration.php

Spacing +2 added lines, -2 removed lines

@@ -12,7 +12,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -37,7 +37,7 @@ 
         } else {
             $reg = null;
         }
-        if (! $reg instanceof \EE_Registration
+        if ( ! $reg instanceof \EE_Registration
         ) {
             throw new \EE_Error(
                 sprintf(

Indentation +55 added lines, -55 removed lines

@@ -13,7 +13,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -21,58 +21,58 @@ 
 class Registration extends Calculations_Base
 {
 
-    /**
-     * Calculates the checkin status for each datetime this registration has access to
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function datetime_checkin_stati($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
-            $reg = \EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
-        } else {
-            $reg = null;
-        }
-        if (! $reg instanceof \EE_Registration
-        ) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Registration.REG_ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        $datetime_ids = \EEM_Datetime::instance()->get_col(
-            array(
-                array(
-                    'Ticket.TKT_ID' => $reg->ticket_ID(),
-                ),
-                'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
-            )
-        );
-        $checkin_stati = array();
-        foreach ($datetime_ids as $datetime_id) {
-            $status = $reg->check_in_status_for_datetime($datetime_id);
-            switch ($status) {
-                case \EE_Registration::checkin_status_out:
-                    $status_pretty = 'OUT';
-                    break;
-                case \EE_Registration::checkin_status_in:
-                    $status_pretty = 'IN';
-                    break;
-                case \EE_Registration::checkin_status_never:
-                default:
-                    $status_pretty = 'NEVER';
-                    break;
-            }
-            $checkin_stati[$datetime_id] = $status_pretty;
-        }
-        return $checkin_stati;
-    }
+	/**
+	 * Calculates the checkin status for each datetime this registration has access to
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function datetime_checkin_stati($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Registration.REG_ID'])) {
+			$reg = \EEM_Registration::instance()->get_one_by_ID($wpdb_row['Registration.REG_ID']);
+		} else {
+			$reg = null;
+		}
+		if (! $reg instanceof \EE_Registration
+		) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate datetime_checkin_stati because the registration with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Registration.REG_ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		$datetime_ids = \EEM_Datetime::instance()->get_col(
+			array(
+				array(
+					'Ticket.TKT_ID' => $reg->ticket_ID(),
+				),
+				'default_where_conditions' => \EEM_Base::default_where_conditions_minimum_all
+			)
+		);
+		$checkin_stati = array();
+		foreach ($datetime_ids as $datetime_id) {
+			$status = $reg->check_in_status_for_datetime($datetime_id);
+			switch ($status) {
+				case \EE_Registration::checkin_status_out:
+					$status_pretty = 'OUT';
+					break;
+				case \EE_Registration::checkin_status_in:
+					$status_pretty = 'IN';
+					break;
+				case \EE_Registration::checkin_status_never:
+				default:
+					$status_pretty = 'NEVER';
+					break;
+			}
+			$checkin_stati[$datetime_id] = $status_pretty;
+		}
+		return $checkin_stati;
+	}
 }

core/libraries/rest_api/calculations/Event.php

Indentation +347 added lines, -347 removed lines

@@ -14,7 +14,7 @@ 
  * @since                 $VID:$
  */
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -22,350 +22,350 @@ 
 class Event extends Calculations_Base
 {
 
-    /**
-     * Calculates the total spaces on the event (not subtracting sales, but taking
-     * sales into account; so this is the optimum sales that CAN still be achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function optimum_sales_at_start($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->total_available_spaces(true);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
-     * sales that COULD have been achieved)
-     * See EE_Event::total_available_spaces( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function optimum_sales_now($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->total_available_spaces(false);
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Like optimum_sales_now, but minus total sales so far.
-     * See EE_Event::spaces_remaining_for_sale( true );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spaces_remaining($wpdb_row, $request, $controller)
-    {
-        if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
-            $event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
-        } else {
-            $event_obj = null;
-        }
-        if ($event_obj instanceof \EE_Event) {
-            return $event_obj->spaces_remaining_for_sale();
-        } else {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
-                        'event_espresso'),
-                    $wpdb_row['Event_CPT.ID'],
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-    }
-
-
-
-    /**
-     * Counts the number of approved registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     */
-    public static function spots_taken($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => \EEM_Registration::status_id_approved,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts the number of pending-payment registrations for this event (regardless
-     * of how many datetimes each registrations' ticket purchase is for)
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
-        return \EEM_Registration::instance()->count(
-            array(
-                array(
-                    'EVT_ID' => $wpdb_row['Event_CPT.ID'],
-                    'STS_ID' => \EEM_Registration::status_id_pending_payment,
-                ),
-            ),
-            'REG_ID',
-            true
-        );
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked into one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int|null if permission denied
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_in_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
-        return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
-    }
-
-
-
-    /**
-     * Counts all the registrations who have checked out of one of this events' datetimes
-     * See EE_Event::total_available_spaces( false );
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return int
-     * @throws \EE_Error
-     * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
-     */
-    public static function registrations_checked_out_count($wpdb_row, $request, $controller)
-    {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
-            throw new \EE_Error(
-                sprintf(
-                    __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
-                        'event_espresso'),
-                    print_r($wpdb_row, true)
-                )
-            );
-        }
-        self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
-        return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
-    }
-
-
-
-    /**
-     * Gets the thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_thumbnail($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'thumbnail');
-    }
-
-
-
-    /**
-     * Gets the medium image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_medium($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium');
-    }
-
-
-
-    /**
-     * Gets the medium-large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_medium_large($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium_large');
-    }
-
-
-
-    /**
-     * Gets the large image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_large($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'large');
-    }
-
-
-
-    /**
-     * Gets the post-thumbnail image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_post_thumbnail($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'post-thumbnail');
-    }
-
-
-
-    /**
-     * Gets the full size image
-     *
-     * @param array            $wpdb_row
-     * @param \WP_REST_Request $request
-     * @param Base             $controller
-     * @return array
-     */
-    public static function image_full($wpdb_row, $request, $controller)
-    {
-        return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'full');
-    }
-
-
-
-    /**
-     * Gets image specs and formats them for the display in the API,
-     * according to the image size requested
-     *
-     * @param int    $EVT_ID
-     * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
-     * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
-     */
-    protected static function _calculate_image_data($EVT_ID, $image_size)
-    {
-        $attachment_id = get_post_thumbnail_id($EVT_ID);
-        $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
-            return null;
-        }
-        if (isset($data[3])) {
-            $generated = $data[3];
-        } else {
-            $generated = true;
-        }
-        return array(
-            'url'       => $data[0],
-            'width'     => $data[1],
-            'height'    => $data[2],
-            'generated' => $generated,
-        );
-    }
+	/**
+	 * Calculates the total spaces on the event (not subtracting sales, but taking
+	 * sales into account; so this is the optimum sales that CAN still be achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function optimum_sales_at_start($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->total_available_spaces(true);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate optimum_sales_at_start because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Calculates the total spaces on the event (ignoring all sales; so this is the optimum
+	 * sales that COULD have been achieved)
+	 * See EE_Event::total_available_spaces( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function optimum_sales_now($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->total_available_spaces(false);
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate optimum_sales_now because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Like optimum_sales_now, but minus total sales so far.
+	 * See EE_Event::spaces_remaining_for_sale( true );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spaces_remaining($wpdb_row, $request, $controller)
+	{
+		if (is_array($wpdb_row) && isset($wpdb_row['Event_CPT.ID'])) {
+			$event_obj = \EEM_Event::instance()->get_one_by_ID($wpdb_row['Event_CPT.ID']);
+		} else {
+			$event_obj = null;
+		}
+		if ($event_obj instanceof \EE_Event) {
+			return $event_obj->spaces_remaining_for_sale();
+		} else {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spaces_remaining because the event with ID %1$s (from database row %2$s) was not found',
+						'event_espresso'),
+					$wpdb_row['Event_CPT.ID'],
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+	}
+
+
+
+	/**
+	 * Counts the number of approved registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 */
+	public static function spots_taken($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => \EEM_Registration::status_id_approved,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts the number of pending-payment registrations for this event (regardless
+	 * of how many datetimes each registrations' ticket purchase is for)
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_registrations', 'spots_taken_pending_payment');
+		return \EEM_Registration::instance()->count(
+			array(
+				array(
+					'EVT_ID' => $wpdb_row['Event_CPT.ID'],
+					'STS_ID' => \EEM_Registration::status_id_pending_payment,
+				),
+			),
+			'REG_ID',
+			true
+		);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked into one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int|null if permission denied
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_in_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_in_count');
+		return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], true);
+	}
+
+
+
+	/**
+	 * Counts all the registrations who have checked out of one of this events' datetimes
+	 * See EE_Event::total_available_spaces( false );
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return int
+	 * @throws \EE_Error
+	 * @throws \EventEspresso\core\libraries\rest_api\Rest_Exception
+	 */
+	public static function registrations_checked_out_count($wpdb_row, $request, $controller)
+	{
+		if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+			throw new \EE_Error(
+				sprintf(
+					__('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
+						'event_espresso'),
+					print_r($wpdb_row, true)
+				)
+			);
+		}
+		self::_verify_current_user_can('ee_read_checkins', 'registrations_checked_out_count');
+		return \EEM_Registration::instance()->count_registrations_checked_into_event($wpdb_row['Event_CPT.ID'], false);
+	}
+
+
+
+	/**
+	 * Gets the thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_thumbnail($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the medium image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_medium($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium');
+	}
+
+
+
+	/**
+	 * Gets the medium-large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_medium_large($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'medium_large');
+	}
+
+
+
+	/**
+	 * Gets the large image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_large($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'large');
+	}
+
+
+
+	/**
+	 * Gets the post-thumbnail image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_post_thumbnail($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'post-thumbnail');
+	}
+
+
+
+	/**
+	 * Gets the full size image
+	 *
+	 * @param array            $wpdb_row
+	 * @param \WP_REST_Request $request
+	 * @param Base             $controller
+	 * @return array
+	 */
+	public static function image_full($wpdb_row, $request, $controller)
+	{
+		return self::_calculate_image_data($wpdb_row['Event_CPT.ID'], 'full');
+	}
+
+
+
+	/**
+	 * Gets image specs and formats them for the display in the API,
+	 * according to the image size requested
+	 *
+	 * @param int    $EVT_ID
+	 * @param string $image_size one of these: thumbnail, medium, medium_large, large, post-thumbnail, full
+	 * @return array|false if no such image exists. If array it will have keys 'url', 'width', 'height' and 'original'
+	 */
+	protected static function _calculate_image_data($EVT_ID, $image_size)
+	{
+		$attachment_id = get_post_thumbnail_id($EVT_ID);
+		$data = wp_get_attachment_image_src($attachment_id, $image_size);
+		if (! $data) {
+			return null;
+		}
+		if (isset($data[3])) {
+			$generated = $data[3];
+		} else {
+			$generated = true;
+		}
+		return array(
+			'url'       => $data[0],
+			'width'     => $data[1],
+			'height'    => $data[2],
+			'generated' => $generated,
+		);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -13,7 +13,7 @@ 
  * @author                Mike Nelson
  * @since                 $VID:$
  */
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -135,7 +135,7 @@ 
      */
     public static function spots_taken($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -171,7 +171,7 @@ 
      */
     public static function spots_taken_pending_payment($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate spots_taken_pending_payment because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -208,7 +208,7 @@ 
      */
     public static function registrations_checked_in_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_in_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -236,7 +236,7 @@ 
      */
     public static function registrations_checked_out_count($wpdb_row, $request, $controller)
     {
-        if (! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
+        if ( ! is_array($wpdb_row) || ! isset($wpdb_row['Event_CPT.ID'])) {
             throw new \EE_Error(
                 sprintf(
                     __('Cannot calculate registrations_checked_out_count because the database row %1$s does not have an entry for "Event_CPT.ID"',
@@ -353,7 +353,7 @@ 
     {
         $attachment_id = get_post_thumbnail_id($EVT_ID);
         $data = wp_get_attachment_image_src($attachment_id, $image_size);
-        if (! $data) {
+        if ( ! $data) {
             return null;
         }
         if (isset($data[3])) {