eventespresso / event-espresso-core

core/libraries/rest_api/ModelVersionInfo.php

Indentation +420 added lines, -420 removed lines

@@ -25,424 +25,424 @@
  */
 class ModelVersionInfo
 {
-    /**
-     * 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';
-
-    /**
-     * @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 string $requested_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
-     */
-    protected array $model_changes = [];
-
-    /**
-     * 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'
-     */
-    protected array $resource_changes = [];
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     */
-    protected array $cached_fields_on_models = [];
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     */
-    protected ?array $cached_models_for_requested_version = null;
-
-    protected ?array $cached_model_changes_between_requested_version_and_current = null;
-
-    protected ?array $cached_resource_changes_between_requested_version_and_current = null;
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct(string $requested_version)
-    {
-        $this->requested_version = $requested_version;
-        $this->model_changes     = [
-            '4.8.29' => [
-                // first version where the REST API is in EE core, so no need
-                // to specify how it's different from the previous
-            ],
-        ];
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = (array) apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            []
-        );
-        $defaults               = [
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        ];
-        foreach ($this->resource_changes as $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 modelChangesBetweenRequestedVersionAndCurrent(): array
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = [];
-            foreach ($this->modelChanges() as $version => $models_changed_in_version) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $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 resourceChangesBetweenRequestedVersionAndCurrent(): array
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = [];
-            foreach ($this->resourceChanges() as $version => $model_classnames) {
-                if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $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 requestedVersion(): string
-    {
-        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 modelChanges(): array
-    {
-        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 modelsForRequestedVersion(): array
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $models_changed) {
-                foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
-                    if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
-                    }
-                }
-            }
-            $this->cached_models_for_requested_version = (array) 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 isModelNameInThisVersion(string $model_name): bool
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        return isset($model_names[ $model_name ]);
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return EEM_Base|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function loadModel(string $model_name): ?EEM_Base
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
-                    'event_espresso'
-                ),
-                $model_name,
-                $this->requestedVersion()
-            )
-        );
-    }
-
-
-    /**
-     * Gets all the fields that should exist on this model right now
-     *
-     * @param EEM_Base $model
-     * @return array|EE_Model_Field_Base[]
-     */
-    public function fieldsOnModelInThisVersion(EEM_Base $model): array
-    {
-        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->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $changes_in_version) {
-                if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::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 isSubclassOfOne(object $object, array $classnames): bool
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored(): array
-    {
-        return (array) apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            []
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @return boolean
-     */
-    public function fieldIsIgnored(EE_Model_Field_Base $field_obj): bool
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
-    }
-
-
-    /**
-     * 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 fieldsThatHaveRenderedFormat(): array
-    {
-        return (array) apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            ['EE_Post_Content_Field', 'EE_Full_HTML_Field']
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @return bool
-     */
-    public function fieldHasRenderedFormat(EE_Model_Field_Base $field_obj): bool
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
-    }
-
-
-    /**
-     * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
-     * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
-     * to view
-     *
-     * @return array an array of EE_Model_Field_Base child classnames
-     */
-    public function fieldsThatHavePrettyFormat(): array
-    {
-        return (array) apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            ['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 $field_obj
-     * @return bool
-     */
-    public function fieldHasPrettyFormat(EE_Model_Field_Base $field_obj): bool
-    {
-        return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
-    }
-
-
-    /**
-     * 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 resourceChanges(): array
-    {
-        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.
-     *
-     * @param EEM_Base $model
-     * @return array
-     * @see Model_Version::_resource_changes
-     */
-    public function extraResourcePropertiesForModel(EEM_Base $model): array
-    {
-        $extra_properties = [];
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $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 relationSettings(EEM_Base $model): array
-    {
-        $relations = [];
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
-            }
-        }
-        // filter the results, but use the old filter name
-        return (array) 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';
+
+	/**
+	 * @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 string $requested_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
+	 */
+	protected array $model_changes = [];
+
+	/**
+	 * 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'
+	 */
+	protected array $resource_changes = [];
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 */
+	protected array $cached_fields_on_models = [];
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 */
+	protected ?array $cached_models_for_requested_version = null;
+
+	protected ?array $cached_model_changes_between_requested_version_and_current = null;
+
+	protected ?array $cached_resource_changes_between_requested_version_and_current = null;
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct(string $requested_version)
+	{
+		$this->requested_version = $requested_version;
+		$this->model_changes     = [
+			'4.8.29' => [
+				// first version where the REST API is in EE core, so no need
+				// to specify how it's different from the previous
+			],
+		];
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = (array) apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			[]
+		);
+		$defaults               = [
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		];
+		foreach ($this->resource_changes as $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 modelChangesBetweenRequestedVersionAndCurrent(): array
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = [];
+			foreach ($this->modelChanges() as $version => $models_changed_in_version) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$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 resourceChangesBetweenRequestedVersionAndCurrent(): array
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = [];
+			foreach ($this->resourceChanges() as $version => $model_classnames) {
+				if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
+					$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 requestedVersion(): string
+	{
+		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 modelChanges(): array
+	{
+		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 modelsForRequestedVersion(): array
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $models_changed) {
+				foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
+					if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
+						unset($all_models_in_current_version[ $model_name ]);
+					}
+				}
+			}
+			$this->cached_models_for_requested_version = (array) 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 isModelNameInThisVersion(string $model_name): bool
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		return isset($model_names[ $model_name ]);
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return EEM_Base|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function loadModel(string $model_name): ?EEM_Base
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'Cannot load model "%1$s" because it does not exist in version %2$s of Event Espresso',
+					'event_espresso'
+				),
+				$model_name,
+				$this->requestedVersion()
+			)
+		);
+	}
+
+
+	/**
+	 * Gets all the fields that should exist on this model right now
+	 *
+	 * @param EEM_Base $model
+	 * @return array|EE_Model_Field_Base[]
+	 */
+	public function fieldsOnModelInThisVersion(EEM_Base $model): array
+	{
+		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->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $changes_in_version) {
+				if (
+					isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::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 isSubclassOfOne(object $object, array $classnames): bool
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored(): array
+	{
+		return (array) apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			[]
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @return boolean
+	 */
+	public function fieldIsIgnored(EE_Model_Field_Base $field_obj): bool
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsIgnored());
+	}
+
+
+	/**
+	 * 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 fieldsThatHaveRenderedFormat(): array
+	{
+		return (array) apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			['EE_Post_Content_Field', 'EE_Full_HTML_Field']
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @return bool
+	 */
+	public function fieldHasRenderedFormat(EE_Model_Field_Base $field_obj): bool
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHaveRenderedFormat());
+	}
+
+
+	/**
+	 * Returns the list of model field classes that have a "_pretty" and non-pretty versions.
+	 * The pretty version of the field is NOT query-able or editable, but requires no extra permissions
+	 * to view
+	 *
+	 * @return array an array of EE_Model_Field_Base child classnames
+	 */
+	public function fieldsThatHavePrettyFormat(): array
+	{
+		return (array) apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			['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 $field_obj
+	 * @return bool
+	 */
+	public function fieldHasPrettyFormat(EE_Model_Field_Base $field_obj): bool
+	{
+		return $this->isSubclassOfOne($field_obj, $this->fieldsThatHavePrettyFormat());
+	}
+
+
+	/**
+	 * 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 resourceChanges(): array
+	{
+		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.
+	 *
+	 * @param EEM_Base $model
+	 * @return array
+	 * @see Model_Version::_resource_changes
+	 */
+	public function extraResourcePropertiesForModel(EEM_Base $model): array
+	{
+		$extra_properties = [];
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $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 relationSettings(EEM_Base $model): array
+	{
+		$relations = [];
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($this->isModelNameInThisVersion($relation_name)) {
+				$relations[ $relation_name ] = $relation_obj;
+			}
+		}
+		// filter the results, but use the old filter name
+		return (array) apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

Spacing +13 added lines, -13 removed lines

@@ -93,7 +93,7 @@ 
             'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
             []
         );
-        $defaults               = [
+        $defaults = [
             'raw'              => false,
             'type'             => 'N/A',
             'nullable'         => true,
@@ -104,10 +104,10 @@ 
         foreach ($this->resource_changes as $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;
+                    $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;
+                        if ( ! isset($this->resource_changes[$model_classname][$fieldname][$attribute])) {
+                            $this->resource_changes[$model_classname][$fieldname][$attribute] = $default_value;
                         }
                     }
                 }
@@ -129,7 +129,7 @@ 
             $model_changes = [];
             foreach ($this->modelChanges() as $version => $models_changed_in_version) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $model_changes[ $version ] = $models_changed_in_version;
+                    $model_changes[$version] = $models_changed_in_version;
                 }
             }
             $this->cached_model_changes_between_requested_version_and_current = $model_changes;
@@ -151,7 +151,7 @@ 
             $resource_changes = [];
             foreach ($this->resourceChanges() as $version => $model_classnames) {
                 if ($version <= EED_Core_Rest_Api::core_version() && $version > $this->requestedVersion()) {
-                    $resource_changes[ $version ] = $model_classnames;
+                    $resource_changes[$version] = $model_classnames;
                 }
             }
             $this->cached_resource_changes_between_requested_version_and_current = $resource_changes;
@@ -202,7 +202,7 @@ 
             foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $models_changed) {
                 foreach ($models_changed as $model_name => $new_indicator_or_fields_added) {
                     if ($new_indicator_or_fields_added === ModelVersionInfo::MODEL_ADDED) {
-                        unset($all_models_in_current_version[ $model_name ]);
+                        unset($all_models_in_current_version[$model_name]);
                     }
                 }
             }
@@ -227,7 +227,7 @@ 
     public function isModelNameInThisVersion(string $model_name): bool
     {
         $model_names = $this->modelsForRequestedVersion();
-        return isset($model_names[ $model_name ]);
+        return isset($model_names[$model_name]);
     }
 
 
@@ -266,7 +266,7 @@ 
      */
     public function fieldsOnModelInThisVersion(EEM_Base $model): array
     {
-        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->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model
@@ -274,12 +274,12 @@ 
             // remove all fields that have been added since
             foreach ($changes as $changes_in_version) {
                 if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== ModelVersionInfo::MODEL_ADDED
+                    isset($changes_in_version[$model->get_this_model_name()])
+                    && $changes_in_version[$model->get_this_model_name()] !== ModelVersionInfo::MODEL_ADDED
                 ) {
                     $current_fields = array_diff_key(
                         $current_fields,
-                        array_flip($changes_in_version[ $model->get_this_model_name() ])
+                        array_flip($changes_in_version[$model->get_this_model_name()])
                     );
                 }
             }
@@ -435,7 +435,7 @@ 
         $relations = [];
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($this->isModelNameInThisVersion($relation_name)) {
-                $relations[ $relation_name ] = $relation_obj;
+                $relations[$relation_name] = $relation_obj;
             }
         }
         // filter the results, but use the old filter name

core/libraries/rest_api/RestException.php

Indentation +42 added lines, -42 removed lines

@@ -17,46 +17,46 @@
  */
 class RestException extends EE_Error
 {
-    protected array $wp_error_data = [];
-
-    protected string $wp_error_code = '';
-
-
-    public function __construct(
-        string $string_code,
-        string $message,
-        array $wp_error_data = [],
-        ?Exception $previous = null
-    ) {
-        $this->wp_error_code = $string_code;
-        $this->wp_error_data = $wp_error_data;
-
-        parent::__construct(
-            $message,
-            ! empty($wp_error_data['status']) ? $wp_error_data['status'] : 500,
-            $previous
-        );
-    }
-
-
-    /**
-     * Array of data that may have been set during the constructor, intended for WP_Error's data
-     *
-     * @return array
-     */
-    public function getData(): array
-    {
-        return $this->wp_error_data;
-    }
-
-
-    /**
-     * Gets the error string
-     *
-     * @return string
-     */
-    public function getStringCode(): string
-    {
-        return $this->wp_error_code;
-    }
+	protected array $wp_error_data = [];
+
+	protected string $wp_error_code = '';
+
+
+	public function __construct(
+		string $string_code,
+		string $message,
+		array $wp_error_data = [],
+		?Exception $previous = null
+	) {
+		$this->wp_error_code = $string_code;
+		$this->wp_error_data = $wp_error_data;
+
+		parent::__construct(
+			$message,
+			! empty($wp_error_data['status']) ? $wp_error_data['status'] : 500,
+			$previous
+		);
+	}
+
+
+	/**
+	 * Array of data that may have been set during the constructor, intended for WP_Error's data
+	 *
+	 * @return array
+	 */
+	public function getData(): array
+	{
+		return $this->wp_error_data;
+	}
+
+
+	/**
+	 * Gets the error string
+	 *
+	 * @return string
+	 */
+	public function getStringCode(): string
+	{
+		return $this->wp_error_code;
+	}
 }

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +788 added lines, -788 removed lines

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

Spacing +3 added lines, -3 removed lines

@@ -491,7 +491,7 @@ 
     {
         // the value should be JSON or CSV
         $values = json_decode($sub_array_value);
-        if (! is_array($values)) {
+        if ( ! is_array($values)) {
             $values = array_filter(
                 array_map(
                     'trim',
@@ -514,7 +514,7 @@ 
      */
     private function assertSimplifiedSpecifiedOperator()
     {
-        if (! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
+        if ( ! $this->valueIsSimplifiedSpecifiedOperator() && EED_Core_Rest_Api::debugMode()) {
             throw new RestException(
                 'numerically_indexed_array_of_values_only',
                 sprintf(
@@ -575,7 +575,7 @@ 
         $valid_operators   = $this->getContext()->getModel()->valid_operators();
         $query_param_value = $this->getQueryParamValue();
         return isset($query_param_value[0])
-            && isset($valid_operators[ $query_param_value[0] ]);
+            && isset($valid_operators[$query_param_value[0]]);
     }
 
 

core/libraries/rest_api/Capabilities.php

Indentation +189 added lines, -189 removed lines

@@ -16,203 +16,203 @@
  */
 class Capabilities
 {
-    /**
-     * The current user can see at least SOME of these entities.
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return boolean
-     * @throws EE_Error
-     */
-    public static function currentUserHasPartialAccessTo(
-        EEM_Base $model,
-        string $model_context = EEM_Base::caps_read
-    ): bool {
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return true;
-        }
-        foreach ($model->caps_missing($model_context) as $restriction_obj) {
-            if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
-                return false;
-            }
-        }
-        if (
-            apply_filters(
-                'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
-                false,
-                $model,
-                $model
-            )
-        ) {
-            return false;
-        }
-        return true;
-    }
+	/**
+	 * The current user can see at least SOME of these entities.
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public static function currentUserHasPartialAccessTo(
+		EEM_Base $model,
+		string $model_context = EEM_Base::caps_read
+	): bool {
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_begin',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return true;
+		}
+		foreach ($model->caps_missing($model_context) as $restriction_obj) {
+			if ($restriction_obj instanceof EE_Return_None_Where_Conditions) {
+				return false;
+			}
+		}
+		if (
+			apply_filters(
+				'FHEE__Capabilities__current_user_has_partial_access_to__override_end',
+				false,
+				$model,
+				$model
+			)
+		) {
+			return false;
+		}
+		return true;
+	}
 
 
-    /**
-     * Gets an array of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $request_type one of the constants on WP_JSON_Server
-     * @return array
-     * @throws EE_Error
-     */
-    public static function getMissingPermissions(EEM_Base $model, string $request_type = EEM_Base::caps_read): array
-    {
-        return $model->caps_missing($request_type);
-    }
+	/**
+	 * Gets an array of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $request_type one of the constants on WP_JSON_Server
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function getMissingPermissions(EEM_Base $model, string $request_type = EEM_Base::caps_read): array
+	{
+		return $model->caps_missing($request_type);
+	}
 
 
-    /**
-     * Gets a string of all the capabilities the current user is missing that affected
-     * the query
-     *
-     * @param EEM_Base $model
-     * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
-     * @return string
-     * @throws EE_Error
-     */
-    public static function getMissingPermissionsString(
-        EEM_Base $model,
-        string $model_context = EEM_Base::caps_read
-    ): string {
-        return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
-    }
+	/**
+	 * Gets a string of all the capabilities the current user is missing that affected
+	 * the query
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_context one of the return values from EEM_Base::valid_cap_contexts()
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public static function getMissingPermissionsString(
+		EEM_Base $model,
+		string $model_context = EEM_Base::caps_read
+	): string {
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
 
-    /**
-     * "Removes" password-protected fields. Currently that means setting their values to their default.
-     *
-     * @param array            $entity
-     * @param EEM_Base         $model
-     * @param ModelVersionInfo $model_version_info
-     * @return array
-     * @throws EE_Error
-     * @since 4.9.74.p
-     */
-    public static function filterOutPasswordProtectedFields(
-        array $entity,
-        EEM_Base $model,
-        ModelVersionInfo $model_version_info
-    ): array {
-        $has_password = $model->hasPassword();
-        if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
-                $model->getPasswordField(),
-                $model->getPasswordField()->get_default_value(),
-                $model_version_info->requestedVersion()
-            );
-        }
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $has_password
-                && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
-            ) {
-                $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
-                    $field_obj,
-                    $field_obj->get_default_value(),
-                    $model_version_info->requestedVersion()
-                );
-                if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
-                } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw']    = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
-                        $field_obj,
-                        $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
-                        $model_version_info->requestedVersion()
-                    );
-                } else {
-                    // this is most likely an excerpt field. (These should have also had "rendered" and "raw"
-                    // versions, but we missed that, and can't change it without breaking backward compatibility)
-                    // so just remove it (or rather, set its default)
-                    // API clients will just need to look to fields with rendered formats to know if these have
-                    // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
-                }
-            }
-        }
-        return $entity;
-    }
+	/**
+	 * "Removes" password-protected fields. Currently that means setting their values to their default.
+	 *
+	 * @param array            $entity
+	 * @param EEM_Base         $model
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array
+	 * @throws EE_Error
+	 * @since 4.9.74.p
+	 */
+	public static function filterOutPasswordProtectedFields(
+		array $entity,
+		EEM_Base $model,
+		ModelVersionInfo $model_version_info
+	): array {
+		$has_password = $model->hasPassword();
+		if ($has_password) {
+			$entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+				$model->getPasswordField(),
+				$model->getPasswordField()->get_default_value(),
+				$model_version_info->requestedVersion()
+			);
+		}
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$has_password
+				&& $model->getPasswordField()->fieldIsProtected($field_name)
+				&& $entity[ $field_name ]
+			) {
+				$replacement_value = ModelDataTranslator::prepareFieldValueForJson(
+					$field_obj,
+					$field_obj->get_default_value(),
+					$model_version_info->requestedVersion()
+				);
+				if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
+					$entity[ $field_name ]['rendered'] = $replacement_value;
+				} elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
+					$entity[ $field_name ]['raw']    = $replacement_value;
+					$entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+						$field_obj,
+						$field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
+						$model_version_info->requestedVersion()
+					);
+				} else {
+					// this is most likely an excerpt field. (These should have also had "rendered" and "raw"
+					// versions, but we missed that, and can't change it without breaking backward compatibility)
+					// so just remove it (or rather, set its default)
+					// API clients will just need to look to fields with rendered formats to know if these have
+					// been redacted. Sorry.
+					$entity[ $field_name ] = $replacement_value;
+				}
+			}
+		}
+		return $entity;
+	}
 
 
-    /**
-     * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
-     *
-     * @param array            $entity
-     * @param EEM_Base         $model
-     * @param string           $request_type         one of the return values from EEM_Base::valid_cap_contexts()
-     * @param ModelVersionInfo $model_version_info
-     * @param string|null      $primary_key_string   result of EEM_Base::get_index_primary_key_string(), so that we can
-     *                                               use this with models that have no primary key
-     * @return array ready for converting into json
-     */
-    public static function filterOutInaccessibleEntityFields(
-        array $entity,
-        EEM_Base $model,
-        string $request_type,
-        ModelVersionInfo $model_version_info,
-        ?string $primary_key_string = null
-    ): array {
-        foreach ($model->field_settings() as $field_name => $field_obj) {
-            if (
-                $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
-            ) {
-                unset($entity[ $field_name ]['raw']);
-            }
-        }
-        // theoretically we may want to filter out specific fields for specific models
-        return apply_filters(
-            'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
-            $entity,
-            $model,
-            $request_type
-        );
-    }
+	/**
+	 * Takes a entity that's ready to be returned and removes fields which the user shouldn't be able to access.
+	 *
+	 * @param array            $entity
+	 * @param EEM_Base         $model
+	 * @param string           $request_type         one of the return values from EEM_Base::valid_cap_contexts()
+	 * @param ModelVersionInfo $model_version_info
+	 * @param string|null      $primary_key_string   result of EEM_Base::get_index_primary_key_string(), so that we can
+	 *                                               use this with models that have no primary key
+	 * @return array ready for converting into json
+	 */
+	public static function filterOutInaccessibleEntityFields(
+		array $entity,
+		EEM_Base $model,
+		string $request_type,
+		ModelVersionInfo $model_version_info,
+		?string $primary_key_string = null
+	): array {
+		foreach ($model->field_settings() as $field_name => $field_obj) {
+			if (
+				$model_version_info->fieldHasRenderedFormat($field_obj)
+				&& isset($entity[ $field_name ])
+				&& is_array($entity[ $field_name ])
+				&& isset($entity[ $field_name ]['raw'])
+			) {
+				unset($entity[ $field_name ]['raw']);
+			}
+		}
+		// theoretically we may want to filter out specific fields for specific models
+		return apply_filters(
+			'FHEE__Capabilities__filter_out_inaccessible_entity_fields',
+			$entity,
+			$model,
+			$request_type
+		);
+	}
 
 
-    /**
-     * Verifies the current user has at least partial access to do this action on this model.
-     * If not, throws an exception (so we can define the code that sets up this error object
-     * once)
-     *
-     * @param EEM_Base $model
-     * @param string   $model_action_context
-     * @param string   $action_name
-     * @return void
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function verifyAtLeastPartialAccessTo(
-        EEM_Base $model,
-        string $model_action_context,
-        string $action_name = 'list'
-    ): void {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
-            $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
-            throw new RestException(
-                sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
-                sprintf(
-                    esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
-                    $action_name,
-                    $model_name_plural,
-                    Capabilities::getMissingPermissionsString($model, $model_action_context)
-                ),
-                ['status' => 403]
-            );
-        }
-    }
+	/**
+	 * Verifies the current user has at least partial access to do this action on this model.
+	 * If not, throws an exception (so we can define the code that sets up this error object
+	 * once)
+	 *
+	 * @param EEM_Base $model
+	 * @param string   $model_action_context
+	 * @param string   $action_name
+	 * @return void
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function verifyAtLeastPartialAccessTo(
+		EEM_Base $model,
+		string $model_action_context,
+		string $action_name = 'list'
+	): void {
+		if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+			$model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
+			throw new RestException(
+				sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),
+				sprintf(
+					esc_html__('Sorry, you are not allowed to %1$s %2$s. Missing permissions: %3$s', 'event_espresso'),
+					$action_name,
+					$model_name_plural,
+					Capabilities::getMissingPermissionsString($model, $model_action_context)
+				),
+				['status' => 403]
+			);
+		}
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -106,7 +106,7 @@ 
     ): array {
         $has_password = $model->hasPassword();
         if ($has_password) {
-            $entity[ $model->getPasswordField()->get_name() ] = ModelDataTranslator::prepareFieldValueForJson(
+            $entity[$model->getPasswordField()->get_name()] = ModelDataTranslator::prepareFieldValueForJson(
                 $model->getPasswordField(),
                 $model->getPasswordField()->get_default_value(),
                 $model_version_info->requestedVersion()
@@ -116,7 +116,7 @@ 
             if (
                 $has_password
                 && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
+                && $entity[$field_name]
             ) {
                 $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
@@ -124,10 +124,10 @@ 
                     $model_version_info->requestedVersion()
                 );
                 if ($model_version_info->fieldHasRenderedFormat($field_obj)) {
-                    $entity[ $field_name ]['rendered'] = $replacement_value;
+                    $entity[$field_name]['rendered'] = $replacement_value;
                 } elseif ($model_version_info->fieldHasPrettyFormat($field_obj)) {
-                    $entity[ $field_name ]['raw']    = $replacement_value;
-                    $entity[ $field_name ]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
+                    $entity[$field_name]['raw']    = $replacement_value;
+                    $entity[$field_name]['pretty'] = ModelDataTranslator::prepareFieldValueForJson(
                         $field_obj,
                         $field_obj->prepare_for_pretty_echoing($field_obj->get_default_value()),
                         $model_version_info->requestedVersion()
@@ -138,7 +138,7 @@ 
                     // so just remove it (or rather, set its default)
                     // API clients will just need to look to fields with rendered formats to know if these have
                     // been redacted. Sorry.
-                    $entity[ $field_name ] = $replacement_value;
+                    $entity[$field_name] = $replacement_value;
                 }
             }
         }
@@ -167,11 +167,11 @@ 
         foreach ($model->field_settings() as $field_name => $field_obj) {
             if (
                 $model_version_info->fieldHasRenderedFormat($field_obj)
-                && isset($entity[ $field_name ])
-                && is_array($entity[ $field_name ])
-                && isset($entity[ $field_name ]['raw'])
+                && isset($entity[$field_name])
+                && is_array($entity[$field_name])
+                && isset($entity[$field_name]['raw'])
             ) {
-                unset($entity[ $field_name ]['raw']);
+                unset($entity[$field_name]['raw']);
             }
         }
         // theoretically we may want to filter out specific fields for specific models
@@ -201,7 +201,7 @@ 
         string $model_action_context,
         string $action_name = 'list'
     ): void {
-        if (! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
+        if ( ! Capabilities::currentUserHasPartialAccessTo($model, $model_action_context)) {
             $model_name_plural = EEH_Inflector::pluralize_and_lower($model->get_this_model_name());
             throw new RestException(
                 sprintf('rest_cannot_%s_%s', strtolower($action_name), $model_name_plural),

core/libraries/rest_api/RestIncomingQueryParamContext.php

Indentation +46 added lines, -46 removed lines

@@ -18,62 +18,62 @@
  */
 class RestIncomingQueryParamContext
 {
-    private EEM_Base $model;
+	private EEM_Base $model;
 
-    private string $requested_version;
+	private string $requested_version;
 
-    private bool $writing;
+	private bool $writing;
 
 
-    /**
-     * RestIncomingQueryParamContext constructor.
-     *
-     * @param EEM_Base        $model
-     * @param string          $requested_version
-     * @param bool|int|string $writing
-     */
-    public function __construct(EEM_Base $model, string $requested_version, $writing)
-    {
-        $this->model             = $model;
-        $this->requested_version = $requested_version;
-        $this->writing           = filter_var($writing, FILTER_VALIDATE_BOOLEAN);
-    }
+	/**
+	 * RestIncomingQueryParamContext constructor.
+	 *
+	 * @param EEM_Base        $model
+	 * @param string          $requested_version
+	 * @param bool|int|string $writing
+	 */
+	public function __construct(EEM_Base $model, string $requested_version, $writing)
+	{
+		$this->model             = $model;
+		$this->requested_version = $requested_version;
+		$this->writing           = filter_var($writing, FILTER_VALIDATE_BOOLEAN);
+	}
 
 
-    /**
-     * Gets the model currently being requested, eg class EEM_Event
-     *
-     * @return EEM_Base
-     * @since 4.9.72.p
-     */
-    public function getModel(): EEM_Base
-    {
-        return $this->model;
-    }
+	/**
+	 * Gets the model currently being requested, eg class EEM_Event
+	 *
+	 * @return EEM_Base
+	 * @since 4.9.72.p
+	 */
+	public function getModel(): EEM_Base
+	{
+		return $this->model;
+	}
 
 
-    /**
-     * Gets the version being requested, eg 4.8.36
-     *
-     * @return string
-     * @since 4.9.72.p
-     */
-    public function getRequestedVersion(): string
-    {
-        return $this->requested_version;
-    }
+	/**
+	 * Gets the version being requested, eg 4.8.36
+	 *
+	 * @return string
+	 * @since 4.9.72.p
+	 */
+	public function getRequestedVersion(): string
+	{
+		return $this->requested_version;
+	}
 
 
-    /**
-     * Gets if the current request is for a writing request or just simple read
-     *
-     * @return bool
-     * @since 4.9.72.p
-     */
-    public function isWriting(): bool
-    {
-        return $this->writing;
-    }
+	/**
+	 * Gets if the current request is for a writing request or just simple read
+	 *
+	 * @return bool
+	 * @since 4.9.72.p
+	 */
+	public function isWriting(): bool
+	{
+		return $this->writing;
+	}
 }
 // End of file RestIncomingQueryParamContext.php
 // Location: EventEspresso\core\libraries\rest_api/RestIncomingQueryParamContext.php

core/libraries/rest_api/CalculatedModelFields.php

Indentation +170 added lines, -170 removed lines

@@ -21,174 +21,174 @@
  */
 class CalculatedModelFields
 {
-    private CalculatedModelFieldsFactory $factory;
-
-    protected array $mapping = [];
-
-    protected array $mapping_schema = [];
-
-
-    /**
-     * CalculatedModelFields constructor.
-     *
-     * @param CalculatedModelFieldsFactory $factory
-     */
-    public function __construct(CalculatedModelFieldsFactory $factory)
-    {
-        $this->factory = $factory;
-    }
-
-
-    /**
-     * @param bool $refresh
-     * @return array top-level-keys are model names (eg "Event")
-     * next-level are the calculated field names AND method names on classes
-     * which perform calculations, values are the fully qualified classnames which do the calculations
-     * These callbacks should accept as arguments:
-     * the wpdb row results,
-     * the WP_Request object,
-     * the controller object
-     */
-    public function mapping(bool $refresh = false): array
-    {
-        if (! $this->mapping || $refresh) {
-            $this->mapping = $this->generateNewMapping();
-        }
-        return $this->mapping;
-    }
-
-
-    /**
-     * Generates a new mapping between model calculated fields and their callbacks
-     *
-     * @return array
-     */
-    protected function generateNewMapping(): array
-    {
-        $mapping                       = [];
-        $models_with_calculated_fields = [
-            'Attendee',
-            'Datetime',
-            'Event',
-            'Registration',
-        ];
-        foreach ($models_with_calculated_fields as $model_name) {
-            $calculator = $this->factory->createFromModel($model_name);
-            foreach (array_keys(call_user_func([$calculator, 'schemaForCalculations'])) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
-            }
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
-            $mapping
-        );
-    }
-
-
-    /**
-     * Generates the schema for each calculation index in the calculation map.
-     *
-     * @return array
-     * @throws UnexpectedEntityException
-     */
-    protected function generateNewMappingSchema(): array
-    {
-        $schema_map = [];
-        foreach ($this->mapping() as $map_model => $map_for_model) {
-            /**
-             * @var string $calculation_index
-             * @var string $calculations_class
-             */
-            foreach ($map_for_model as $calculation_index => $calculations_class) {
-                $calculator = $this->factory->createFromClassname($calculations_class);
-                $schema     = call_user_func([$calculator, 'schemaForCalculation'], $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
-                }
-            }
-        }
-        return $schema_map;
-    }
-
-
-    /**
-     * Gets the known calculated fields for model
-     *
-     * @param EEM_Base $model
-     * @return array allowable values for this field
-     */
-    public function retrieveCalculatedFieldsForModel(EEM_Base $model): array
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
-        }
-        return [];
-    }
-
-
-    /**
-     * Returns the JsonSchema for the calculated fields on the given model.
-     *
-     * @param EEM_Base $model
-     * @return array
-     */
-    public function getJsonSchemaForModel(EEM_Base $model): array
-    {
-        if (! $this->mapping_schema) {
-            $this->mapping_schema = $this->generateNewMappingSchema();
-        }
-        return [
-            'description'          => esc_html__(
-                'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
-                'event_espresso'
-            ),
-            'type'                 => 'object',
-            'properties'           => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
-                : [],
-            'additionalProperties' => false,
-            'readonly'             => true,
-        ];
-    }
-
-
-    /**
-     * Retrieves the value for this calculation
-     *
-     * @param EEM_Base       $model
-     * @param string         $field_name
-     * @param array          $wpdb_row
-     * @param                $rest_request
-     * @param BaseController $controller
-     * @return mixed|null
-     * @throws RestException
-     * @throws UnexpectedEntityException
-     */
-    public function retrieveCalculatedFieldValue(
-        EEM_Base $model,
-        string $field_name,
-        array $wpdb_row,
-        $rest_request,
-        Base $controller
-    ) {
-        $mapping = $this->mapping();
-        if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
-        ) {
-            $classname         = $mapping[ $model->get_this_model_name() ][ $field_name ];
-            $calculator        = $this->factory->createFromClassname($classname);
-            $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
-            return call_user_func([$calculator, $class_method_name], $wpdb_row, $rest_request, $controller);
-        }
-        throw new RestException(
-            'calculated_field_does_not_exist',
-            sprintf(
-                esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
-                $field_name,
-                $model->get_this_model_name()
-            )
-        );
-    }
+	private CalculatedModelFieldsFactory $factory;
+
+	protected array $mapping = [];
+
+	protected array $mapping_schema = [];
+
+
+	/**
+	 * CalculatedModelFields constructor.
+	 *
+	 * @param CalculatedModelFieldsFactory $factory
+	 */
+	public function __construct(CalculatedModelFieldsFactory $factory)
+	{
+		$this->factory = $factory;
+	}
+
+
+	/**
+	 * @param bool $refresh
+	 * @return array top-level-keys are model names (eg "Event")
+	 * next-level are the calculated field names AND method names on classes
+	 * which perform calculations, values are the fully qualified classnames which do the calculations
+	 * These callbacks should accept as arguments:
+	 * the wpdb row results,
+	 * the WP_Request object,
+	 * the controller object
+	 */
+	public function mapping(bool $refresh = false): array
+	{
+		if (! $this->mapping || $refresh) {
+			$this->mapping = $this->generateNewMapping();
+		}
+		return $this->mapping;
+	}
+
+
+	/**
+	 * Generates a new mapping between model calculated fields and their callbacks
+	 *
+	 * @return array
+	 */
+	protected function generateNewMapping(): array
+	{
+		$mapping                       = [];
+		$models_with_calculated_fields = [
+			'Attendee',
+			'Datetime',
+			'Event',
+			'Registration',
+		];
+		foreach ($models_with_calculated_fields as $model_name) {
+			$calculator = $this->factory->createFromModel($model_name);
+			foreach (array_keys(call_user_func([$calculator, 'schemaForCalculations'])) as $field_name) {
+				$mapping[ $model_name ][ $field_name ] = get_class($calculator);
+			}
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Calculated_Model_Fields__mapping',
+			$mapping
+		);
+	}
+
+
+	/**
+	 * Generates the schema for each calculation index in the calculation map.
+	 *
+	 * @return array
+	 * @throws UnexpectedEntityException
+	 */
+	protected function generateNewMappingSchema(): array
+	{
+		$schema_map = [];
+		foreach ($this->mapping() as $map_model => $map_for_model) {
+			/**
+			 * @var string $calculation_index
+			 * @var string $calculations_class
+			 */
+			foreach ($map_for_model as $calculation_index => $calculations_class) {
+				$calculator = $this->factory->createFromClassname($calculations_class);
+				$schema     = call_user_func([$calculator, 'schemaForCalculation'], $calculation_index);
+				if (! empty($schema)) {
+					$schema_map[ $map_model ][ $calculation_index ] = $schema;
+				}
+			}
+		}
+		return $schema_map;
+	}
+
+
+	/**
+	 * Gets the known calculated fields for model
+	 *
+	 * @param EEM_Base $model
+	 * @return array allowable values for this field
+	 */
+	public function retrieveCalculatedFieldsForModel(EEM_Base $model): array
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[ $model->get_this_model_name() ])) {
+			return array_keys($mapping[ $model->get_this_model_name() ]);
+		}
+		return [];
+	}
+
+
+	/**
+	 * Returns the JsonSchema for the calculated fields on the given model.
+	 *
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public function getJsonSchemaForModel(EEM_Base $model): array
+	{
+		if (! $this->mapping_schema) {
+			$this->mapping_schema = $this->generateNewMappingSchema();
+		}
+		return [
+			'description'          => esc_html__(
+				'Available calculated fields for this model.  Fields are only present in the response if explicitly requested',
+				'event_espresso'
+			),
+			'type'                 => 'object',
+			'properties'           => isset($this->mapping_schema[ $model->get_this_model_name() ])
+				? $this->mapping_schema[ $model->get_this_model_name() ]
+				: [],
+			'additionalProperties' => false,
+			'readonly'             => true,
+		];
+	}
+
+
+	/**
+	 * Retrieves the value for this calculation
+	 *
+	 * @param EEM_Base       $model
+	 * @param string         $field_name
+	 * @param array          $wpdb_row
+	 * @param                $rest_request
+	 * @param BaseController $controller
+	 * @return mixed|null
+	 * @throws RestException
+	 * @throws UnexpectedEntityException
+	 */
+	public function retrieveCalculatedFieldValue(
+		EEM_Base $model,
+		string $field_name,
+		array $wpdb_row,
+		$rest_request,
+		Base $controller
+	) {
+		$mapping = $this->mapping();
+		if (
+			isset($mapping[ $model->get_this_model_name() ])
+			&& isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+		) {
+			$classname         = $mapping[ $model->get_this_model_name() ][ $field_name ];
+			$calculator        = $this->factory->createFromClassname($classname);
+			$class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
+			return call_user_func([$calculator, $class_method_name], $wpdb_row, $rest_request, $controller);
+		}
+		throw new RestException(
+			'calculated_field_does_not_exist',
+			sprintf(
+				esc_html__('There is no calculated field %1$s on resource %2$s', 'event_espresso'),
+				$field_name,
+				$model->get_this_model_name()
+			)
+		);
+	}
 }

Spacing +12 added lines, -12 removed lines

@@ -51,7 +51,7 @@ 
      */
     public function mapping(bool $refresh = false): array
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -75,7 +75,7 @@ 
         foreach ($models_with_calculated_fields as $model_name) {
             $calculator = $this->factory->createFromModel($model_name);
             foreach (array_keys(call_user_func([$calculator, 'schemaForCalculations'])) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
+                $mapping[$model_name][$field_name] = get_class($calculator);
             }
         }
         return apply_filters(
@@ -102,8 +102,8 @@ 
             foreach ($map_for_model as $calculation_index => $calculations_class) {
                 $calculator = $this->factory->createFromClassname($calculations_class);
                 $schema     = call_user_func([$calculator, 'schemaForCalculation'], $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
+                if ( ! empty($schema)) {
+                    $schema_map[$map_model][$calculation_index] = $schema;
                 }
             }
         }
@@ -120,8 +120,8 @@ 
     public function retrieveCalculatedFieldsForModel(EEM_Base $model): array
     {
         $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
+        if (isset($mapping[$model->get_this_model_name()])) {
+            return array_keys($mapping[$model->get_this_model_name()]);
         }
         return [];
     }
@@ -135,7 +135,7 @@ 
      */
     public function getJsonSchemaForModel(EEM_Base $model): array
     {
-        if (! $this->mapping_schema) {
+        if ( ! $this->mapping_schema) {
             $this->mapping_schema = $this->generateNewMappingSchema();
         }
         return [
@@ -144,8 +144,8 @@ 
                 'event_espresso'
             ),
             'type'                 => 'object',
-            'properties'           => isset($this->mapping_schema[ $model->get_this_model_name() ])
-                ? $this->mapping_schema[ $model->get_this_model_name() ]
+            'properties'           => isset($this->mapping_schema[$model->get_this_model_name()])
+                ? $this->mapping_schema[$model->get_this_model_name()]
                 : [],
             'additionalProperties' => false,
             'readonly'             => true,
@@ -174,10 +174,10 @@ 
     ) {
         $mapping = $this->mapping();
         if (
-            isset($mapping[ $model->get_this_model_name() ])
-            && isset($mapping[ $model->get_this_model_name() ][ $field_name ])
+            isset($mapping[$model->get_this_model_name()])
+            && isset($mapping[$model->get_this_model_name()][$field_name])
         ) {
-            $classname         = $mapping[ $model->get_this_model_name() ][ $field_name ];
+            $classname         = $mapping[$model->get_this_model_name()][$field_name];
             $calculator        = $this->factory->createFromClassname($classname);
             $class_method_name = EEH_Inflector::camelize_all_but_first($field_name);
             return call_user_func([$calculator, $class_method_name], $wpdb_row, $rest_request, $controller);

core/libraries/form_sections/strategies/validation/EE_Required_Validation_Strategy.strategy.php

Indentation +41 added lines, -41 removed lines

@@ -11,51 +11,51 @@
  */
 class EE_Required_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param string $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("This field is required.", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param string $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("This field is required.", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
 
 
-    /**
-     * just checks the field isn't blank, provided the requirement conditions
-     * indicate this input is still required
-     *
-     * @param $normalized_value
-     * @return bool
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value)
-    {
-        if (
-            $normalized_value === ''
-            || $normalized_value === null
-            || $normalized_value === array()
-        ) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
-        }
-        return true;
-    }
+	/**
+	 * just checks the field isn't blank, provided the requirement conditions
+	 * indicate this input is still required
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value)
+	{
+		if (
+			$normalized_value === ''
+			|| $normalized_value === null
+			|| $normalized_value === array()
+		) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'required');
+		}
+		return true;
+	}
 
 
 
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return array(
-            'required' => true,
-            'messages' => array(
-                'required' => $this->get_validation_error_message()
-            )
-        );
-    }
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return array(
+			'required' => true,
+			'messages' => array(
+				'required' => $this->get_validation_error_message()
+			)
+		);
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Equal_To_Validation_Strategy.strategy.php

Indentation +40 added lines, -40 removed lines

@@ -15,44 +15,44 @@
  */
 class EE_Equal_To_Validation_Strategy extends EE_Text_Validation_Strategy
 {
-    protected string $_compare_to = '';
-
-
-    /**
-     * @param string $validation_error_message
-     * @param string $compare_to
-     */
-    public function __construct($validation_error_message = '', $compare_to = '')
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = apply_filters(
-                'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
-                esc_html__('Fields do not match.', 'event_espresso')
-            );
-        }
-        parent::__construct($validation_error_message);
-        $this->_compare_to = $compare_to;
-    }
-
-
-    /**
-     * just checks the field isn't blank
-     *
-     * @param $normalized_value
-     * @return bool
-     */
-    public function validate($normalized_value)
-    {
-        // No need to be validated
-        return true;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function get_jquery_validation_rule_array()
-    {
-        return ['equalTo' => $this->_compare_to, 'messages' => ['equalTo' => $this->get_validation_error_message()]];
-    }
+	protected string $_compare_to = '';
+
+
+	/**
+	 * @param string $validation_error_message
+	 * @param string $compare_to
+	 */
+	public function __construct($validation_error_message = '', $compare_to = '')
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = apply_filters(
+				'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
+				esc_html__('Fields do not match.', 'event_espresso')
+			);
+		}
+		parent::__construct($validation_error_message);
+		$this->_compare_to = $compare_to;
+	}
+
+
+	/**
+	 * just checks the field isn't blank
+	 *
+	 * @param $normalized_value
+	 * @return bool
+	 */
+	public function validate($normalized_value)
+	{
+		// No need to be validated
+		return true;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function get_jquery_validation_rule_array()
+	{
+		return ['equalTo' => $this->_compare_to, 'messages' => ['equalTo' => $this->get_validation_error_message()]];
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -24,7 +24,7 @@
      */
     public function __construct($validation_error_message = '', $compare_to = '')
     {
-        if (! $validation_error_message) {
+        if ( ! $validation_error_message) {
             $validation_error_message = apply_filters(
                 'FHEE__EE_Equal_To_Validation_Strategy____construct__validation_error_message',
                 esc_html__('Fields do not match.', 'event_espresso')

core/libraries/form_sections/base/EE_Form_Section_Validatable.form.php

Indentation +153 added lines, -153 removed lines

@@ -19,157 +19,157 @@
  */
 abstract class EE_Form_Section_Validatable extends EE_Form_Section_Base
 {
-    /**
-     * Array of validation errors in this section. Does not contain validation errors in subsections, however.
-     * Those are stored individually on each subsection.
-     *
-     * @var EE_Validation_Error[]
-     */
-    protected $_validation_errors = array();
-
-
-
-    /**
-     * Errors on this form section. Note: EE_Form_Section_Proper
-     * has another function for getting all errors in this form section and subsections
-     * called get_validation_errors_accumulated
-     *
-     * @return EE_Validation_Error[]
-     */
-    public function get_validation_errors()
-    {
-        return $this->_validation_errors;
-    }
-
-
-
-    /**
-     * returns a comma-separated list of all the validation errors in it.
-     * If we want this to be customizable, we may decide to create a strategy for displaying it
-     *
-     * @return string
-     */
-    public function get_validation_error_string()
-    {
-        $validation_error_messages = array();
-        if ($this->get_validation_errors()) {
-            foreach ($this->get_validation_errors() as $validation_error) {
-                if ($validation_error instanceof EE_Validation_Error) {
-                    $validation_error_messages[] = $validation_error->getMessage();
-                }
-            }
-        }
-        return implode(", ", $validation_error_messages);
-    }
-
-
-
-    /**
-     * Performs validation on this form section (and subsections). Should be called after _normalize()
-     *
-     * @return boolean of whether or not the form section is valid
-     */
-    abstract protected function _validate();
-
-
-
-    /**
-     * Checks if this field has any validation errors
-     *
-     * @return boolean
-     */
-    public function is_valid()
-    {
-        if (count($this->_validation_errors)) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-
-    /**
-     * Sanitizes input for this form section
-     *
-     * @param array $req_data is the full request data
-     * @return boolean of whether a normalization error occurred
-     * @throws EE_Validation_Error
-     */
-    abstract protected function _normalize($req_data);
-
-
-
-    /**
-     * Creates a validation error from the arguments provided, and adds it to the form section's list.
-     * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
-     * adds it to the list of validation errors of errors
-     *
-     * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
-     *                                      proper EE_Validation_Error object
-     * @param string    $error_code         a short key which can be used to uniquely identify the error
-     * @param Exception $previous_exception if there was an exception that caused the error, that exception
-     * @return void
-     */
-    public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
-    {
-        if ($message_or_object instanceof EE_Validation_Error) {
-            $validation_error = $message_or_object;
-            $validation_error->set_form_section($this);
-        } else {
-            $validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
-        }
-        // check if this error is already in the list
-        foreach ($this->_validation_errors as $existing_error) {
-            if ($existing_error->getMessage() === $validation_error->getMessage()) {
-                return;
-            }
-        }
-        $this->_validation_errors[] = $validation_error;
-    }
-
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * gets the sections like
-     * <br><code>password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }</code>
-     * except we leave it as a PHP object, and leave wp_localize_script to
-     * turn it into a JSON object which can be used by the js
-     *
-     * @return array
-     */
-    abstract public function get_jquery_validation_rules();
-
-
-
-    /**
-     * Checks if this form section's data is present in the req data specified
-     *
-     * @param array $req_data usually post data, if null that's what's used
-     * @return boolean
-     */
-    abstract public function form_data_present_in($req_data = null);
-
-
-
-    /**
-     * Removes teh sensitive data from this form section (usually done after
-     * utilizing the data business function, but before saving it somewhere. Eg,
-     * may remove a password from the form after verifying it was correct)
-     *
-     * @return void
-     */
-    abstract public function clean_sensitive_data();
+	/**
+	 * Array of validation errors in this section. Does not contain validation errors in subsections, however.
+	 * Those are stored individually on each subsection.
+	 *
+	 * @var EE_Validation_Error[]
+	 */
+	protected $_validation_errors = array();
+
+
+
+	/**
+	 * Errors on this form section. Note: EE_Form_Section_Proper
+	 * has another function for getting all errors in this form section and subsections
+	 * called get_validation_errors_accumulated
+	 *
+	 * @return EE_Validation_Error[]
+	 */
+	public function get_validation_errors()
+	{
+		return $this->_validation_errors;
+	}
+
+
+
+	/**
+	 * returns a comma-separated list of all the validation errors in it.
+	 * If we want this to be customizable, we may decide to create a strategy for displaying it
+	 *
+	 * @return string
+	 */
+	public function get_validation_error_string()
+	{
+		$validation_error_messages = array();
+		if ($this->get_validation_errors()) {
+			foreach ($this->get_validation_errors() as $validation_error) {
+				if ($validation_error instanceof EE_Validation_Error) {
+					$validation_error_messages[] = $validation_error->getMessage();
+				}
+			}
+		}
+		return implode(", ", $validation_error_messages);
+	}
+
+
+
+	/**
+	 * Performs validation on this form section (and subsections). Should be called after _normalize()
+	 *
+	 * @return boolean of whether or not the form section is valid
+	 */
+	abstract protected function _validate();
+
+
+
+	/**
+	 * Checks if this field has any validation errors
+	 *
+	 * @return boolean
+	 */
+	public function is_valid()
+	{
+		if (count($this->_validation_errors)) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+
+	/**
+	 * Sanitizes input for this form section
+	 *
+	 * @param array $req_data is the full request data
+	 * @return boolean of whether a normalization error occurred
+	 * @throws EE_Validation_Error
+	 */
+	abstract protected function _normalize($req_data);
+
+
+
+	/**
+	 * Creates a validation error from the arguments provided, and adds it to the form section's list.
+	 * If such an EE_Validation_Error object is passed in as the first arg, simply sets this as its form section, and
+	 * adds it to the list of validation errors of errors
+	 *
+	 * @param mixed     $message_or_object  internationalized string describing the validation error; or it could be a
+	 *                                      proper EE_Validation_Error object
+	 * @param string    $error_code         a short key which can be used to uniquely identify the error
+	 * @param Exception $previous_exception if there was an exception that caused the error, that exception
+	 * @return void
+	 */
+	public function add_validation_error($message_or_object, $error_code = null, $previous_exception = null)
+	{
+		if ($message_or_object instanceof EE_Validation_Error) {
+			$validation_error = $message_or_object;
+			$validation_error->set_form_section($this);
+		} else {
+			$validation_error = new EE_Validation_Error($message_or_object, $error_code, $this, $previous_exception);
+		}
+		// check if this error is already in the list
+		foreach ($this->_validation_errors as $existing_error) {
+			if ($existing_error->getMessage() === $validation_error->getMessage()) {
+				return;
+			}
+		}
+		$this->_validation_errors[] = $validation_error;
+	}
+
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * gets the sections like
+	 * <br><code>password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 * except we leave it as a PHP object, and leave wp_localize_script to
+	 * turn it into a JSON object which can be used by the js
+	 *
+	 * @return array
+	 */
+	abstract public function get_jquery_validation_rules();
+
+
+
+	/**
+	 * Checks if this form section's data is present in the req data specified
+	 *
+	 * @param array $req_data usually post data, if null that's what's used
+	 * @return boolean
+	 */
+	abstract public function form_data_present_in($req_data = null);
+
+
+
+	/**
+	 * Removes teh sensitive data from this form section (usually done after
+	 * utilizing the data business function, but before saving it somewhere. Eg,
+	 * may remove a password from the form after verifying it was correct)
+	 *
+	 * @return void
+	 */
+	abstract public function clean_sensitive_data();
 }