eventespresso / event-espresso-core

core/libraries/rest_api/Capabilities.php

Spacing +11 added lines, -11 removed lines

@@ -99,7 +99,7 @@ 
     ) {
         $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()
@@ -109,7 +109,7 @@ 
             if (
                 $has_password
                 && $model->getPasswordField()->fieldIsProtected($field_name)
-                && $entity[ $field_name ]
+                && $entity[$field_name]
             ) {
                 $replacement_value = ModelDataTranslator::prepareFieldValueForJson(
                     $field_obj,
@@ -117,10 +117,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()
@@ -131,7 +131,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;
                 }
             }
         }
@@ -160,11 +160,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
@@ -190,7 +190,7 @@ 
      */
     public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
     {
-        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),

Indentation +177 added lines, -177 removed lines

@@ -17,190 +17,190 @@
  */
 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
-     */
-    public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
-    {
-        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 $capability_name => $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
+	 */
+	public static function currentUserHasPartialAccessTo($model, $model_context = EEM_Base::caps_read)
+	{
+		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 $capability_name => $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
-     */
-    public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
-    {
-        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
+	 */
+	public static function getMissingPermissions($model, $request_type = EEM_Base::caps_read)
+	{
+		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
-     */
-    public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
-    {
-        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
+	 */
+	public static function getMissingPermissionsString($model, $model_context = EEM_Base::caps_read)
+	{
+		return implode(',', array_keys(self::getMissingPermissions($model, $model_context)));
+	}
 
-    /**
-     * "Removes" password-protected fields. Currently that means setting their values to their default.
-     * @since 4.9.74.p
-     * @param array $entity
-     * @param EEM_Base $model
-     * @param ModelVersionInfo $model_version_info
-     * @return array
-     * @throws EE_Error
-     */
-    public static function filterOutPasswordProtectedFields(
-        $entity,
-        EEM_Base $model,
-        ModelVersionInfo $model_version_info
-    ) {
-        $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.
+	 * @since 4.9.74.p
+	 * @param array $entity
+	 * @param EEM_Base $model
+	 * @param ModelVersionInfo $model_version_info
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function filterOutPasswordProtectedFields(
+		$entity,
+		EEM_Base $model,
+		ModelVersionInfo $model_version_info
+	) {
+		$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 $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(
-        $entity,
-        $model,
-        $request_type,
-        $model_version_info,
-        $primary_key_string = null
-    ) {
-        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 $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(
+		$entity,
+		$model,
+		$request_type,
+		$model_version_info,
+		$primary_key_string = null
+	) {
+		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
-     */
-    public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
-    {
-        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)
-                ),
-                array('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
+	 */
+	public static function verifyAtLeastPartialAccessTo($model, $model_action_context, $action_name = 'list')
+	{
+		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)
+				),
+				array('status' => 403)
+			);
+		}
+	}
 }

core/libraries/rest_api/RestIncomingQueryParamMetadata.php

Indentation +701 added lines, -701 removed lines

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

Spacing +13 added lines, -13 removed lines

@@ -209,7 +209,7 @@ 
         ));
         // double-check is it a *_gmt field?
         if (
-            !$this->getField() instanceof EE_Model_Field_Base
+            ! $this->getField() instanceof EE_Model_Field_Base
             && ModelDataTranslator::isGmtDateFieldName($this->getQueryParamKeySansStars())
         ) {
             // yep, take off '_gmt', and find the field
@@ -330,7 +330,7 @@ 
      */
     private function valueIsArrayDuringRead()
     {
-        return !$this->getContext()->isWriting() && is_array($this->getQueryParamValue());
+        return ! $this->getContext()->isWriting() && is_array($this->getQueryParamValue());
     }
 
     /**
@@ -341,7 +341,7 @@ 
      */
     private function valueIsAssociativeArray()
     {
-        return !EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
+        return ! EEH_Array::is_array_numerically_and_sequentially_indexed($this->getQueryParamValue());
     }
 
     /**
@@ -429,7 +429,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',
@@ -450,7 +450,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(
@@ -505,7 +505,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]]);
     }
 
     /**
@@ -523,7 +523,7 @@ 
         )
             && isset($valueArray[1])
             && is_array($valueArray[1])
-            && !isset($valueArray[2]);
+            && ! isset($valueArray[2]);
     }
 
     /**
@@ -541,8 +541,8 @@ 
             && 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]);
+            && ! isset($query_param_value[1][2])
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -556,7 +556,7 @@ 
         $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]);
+            && ! isset($query_param_value[2]);
     }
 
     /**
@@ -569,7 +569,7 @@ 
     {
         $query_param_value = $this->getQueryParamValue();
         return array_key_exists($operator, $this->getContext()->getModel()->valid_null_style_operators())
-            && !isset($query_param_value[1]);
+            && ! isset($query_param_value[1]);
     }
 
     /**
@@ -583,8 +583,8 @@ 
         $query_param_value = $this->getQueryParamValue();
         $model = $this->getContext()->getModel();
         return isset($query_param_value[1])
-            && !isset($query_param_value[2])
-            && !array_key_exists(
+            && ! isset($query_param_value[2])
+            && ! array_key_exists(
                 $operator,
                 array_merge(
                     $model->valid_in_style_operators(),

core/libraries/rest_api/changes/ChangesIn40834.php

Indentation +33 added lines, -33 removed lines

@@ -12,39 +12,39 @@
 class ChangesIn40834 extends ChangesInBase
 {
 
-    /**
-     * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
-     */
-    public function setHooks()
-    {
-        // set a hook to remove the checkout/checkout endpoints if the request
-        // is for lower than 4.8.33
-        add_filter(
-            'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
-            array($this, 'removeResponseHeaders'),
-            10,
-            3
-        );
-    }
+	/**
+	 * Adds hooks so requests to 4.8.29 don't have the checkin endpoints
+	 */
+	public function setHooks()
+	{
+		// set a hook to remove the checkout/checkout endpoints if the request
+		// is for lower than 4.8.33
+		add_filter(
+			'FHEE__EventEspresso\core\libraries\rest_api\controllers\Base___get_response_headers',
+			array($this, 'removeResponseHeaders'),
+			10,
+			3
+		);
+	}
 
 
-    /**
-     * Removes the checkin and checkout endpoints from the index for requests
-     * to api versions lowers than 4.8.33
-     *
-     * @param array  $response_headers
-     * @param Base   $controller
-     * @param string $requested_version
-     * @return array like $routes_on_this_version
-     */
-    public function removeResponseHeaders($response_headers, $controller, $requested_version)
-    {
-        if (
-            $controller instanceof Base
-            && $this->appliesToVersion($requested_version)
-        ) {
-            return array();
-        }
-        return $response_headers;
-    }
+	/**
+	 * Removes the checkin and checkout endpoints from the index for requests
+	 * to api versions lowers than 4.8.33
+	 *
+	 * @param array  $response_headers
+	 * @param Base   $controller
+	 * @param string $requested_version
+	 * @return array like $routes_on_this_version
+	 */
+	public function removeResponseHeaders($response_headers, $controller, $requested_version)
+	{
+		if (
+			$controller instanceof Base
+			&& $this->appliesToVersion($requested_version)
+		) {
+			return array();
+		}
+		return $response_headers;
+	}
 }

core/libraries/rest_api/CalculatedModelFields.php

Spacing +12 added lines, -12 removed lines

@@ -57,7 +57,7 @@ 
      */
     public function mapping($refresh = false)
     {
-        if (! $this->mapping || $refresh) {
+        if ( ! $this->mapping || $refresh) {
             $this->mapping = $this->generateNewMapping();
         }
         return $this->mapping;
@@ -81,7 +81,7 @@ 
         foreach ($models_with_calculated_fields as $model_name) {
             $calculator = $this->factory->createFromModel($model_name);
             foreach (array_keys(call_user_func(array($calculator, 'schemaForCalculations'))) as $field_name) {
-                $mapping[ $model_name ][ $field_name ] = get_class($calculator);
+                $mapping[$model_name][$field_name] = get_class($calculator);
             }
         }
         return apply_filters(
@@ -108,8 +108,8 @@ 
             foreach ($map_for_model as $calculation_index => $calculations_class) {
                 $calculator = $this->factory->createFromClassname($calculations_class);
                 $schema = call_user_func(array($calculator, 'schemaForCalculation'), $calculation_index);
-                if (! empty($schema)) {
-                    $schema_map[ $map_model ][ $calculation_index ] = $schema;
+                if ( ! empty($schema)) {
+                    $schema_map[$map_model][$calculation_index] = $schema;
                 }
             }
         }
@@ -126,8 +126,8 @@ 
     public function retrieveCalculatedFieldsForModel(EEM_Base $model)
     {
         $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 array();
     }
@@ -140,7 +140,7 @@ 
      */
     public function getJsonSchemaForModel(EEM_Base $model)
     {
-        if (! $this->mapping_schema) {
+        if ( ! $this->mapping_schema) {
             $this->mapping_schema = $this->generateNewMappingSchema();
         }
         return array(
@@ -149,8 +149,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()]
                 : array(),
             'additionalProperties' => false,
             'readonly' => true,
@@ -179,10 +179,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(array($calculator, $class_method_name), $wpdb_row, $rest_request, $controller);

Indentation +174 added lines, -174 removed lines

@@ -21,178 +21,178 @@
  */
 class CalculatedModelFields
 {
-    /**
-     * @var array
-     */
-    protected $mapping;
-
-    /**
-     * @var array
-     */
-    protected $mapping_schema;
-
-    /**
-     * @var CalculatedModelFieldsFactory
-     */
-    private $factory;
-
-    /**
-     * 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($refresh = false)
-    {
-        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()
-    {
-        $mapping = array();
-        $models_with_calculated_fields = array(
-            'Attendee',
-            'Datetime',
-            'Event',
-            'Registration'
-        );
-        foreach ($models_with_calculated_fields as $model_name) {
-            $calculator = $this->factory->createFromModel($model_name);
-            foreach (array_keys(call_user_func(array($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()
-    {
-        $schema_map = array();
-        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(array($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)
-    {
-        $mapping = $this->mapping();
-        if (isset($mapping[ $model->get_this_model_name() ])) {
-            return array_keys($mapping[ $model->get_this_model_name() ]);
-        }
-        return array();
-    }
-
-
-    /**
-     * Returns the JsonSchema for the calculated fields on the given model.
-     * @param EEM_Base $model
-     * @return array
-     */
-    public function getJsonSchemaForModel(EEM_Base $model)
-    {
-        if (! $this->mapping_schema) {
-            $this->mapping_schema = $this->generateNewMappingSchema();
-        }
-        return array(
-            '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() ]
-                : array(),
-            '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,
-        $field_name,
-        $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(array($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()
-            )
-        );
-    }
+	/**
+	 * @var array
+	 */
+	protected $mapping;
+
+	/**
+	 * @var array
+	 */
+	protected $mapping_schema;
+
+	/**
+	 * @var CalculatedModelFieldsFactory
+	 */
+	private $factory;
+
+	/**
+	 * 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($refresh = false)
+	{
+		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()
+	{
+		$mapping = array();
+		$models_with_calculated_fields = array(
+			'Attendee',
+			'Datetime',
+			'Event',
+			'Registration'
+		);
+		foreach ($models_with_calculated_fields as $model_name) {
+			$calculator = $this->factory->createFromModel($model_name);
+			foreach (array_keys(call_user_func(array($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()
+	{
+		$schema_map = array();
+		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(array($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)
+	{
+		$mapping = $this->mapping();
+		if (isset($mapping[ $model->get_this_model_name() ])) {
+			return array_keys($mapping[ $model->get_this_model_name() ]);
+		}
+		return array();
+	}
+
+
+	/**
+	 * Returns the JsonSchema for the calculated fields on the given model.
+	 * @param EEM_Base $model
+	 * @return array
+	 */
+	public function getJsonSchemaForModel(EEM_Base $model)
+	{
+		if (! $this->mapping_schema) {
+			$this->mapping_schema = $this->generateNewMappingSchema();
+		}
+		return array(
+			'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() ]
+				: array(),
+			'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,
+		$field_name,
+		$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(array($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()
+			)
+		);
+	}
 }

core/libraries/rest_api/ModelVersionInfo.php

Spacing +12 added lines, -12 removed lines

@@ -114,10 +114,10 @@ 
         foreach ($this->resource_changes as $version => $model_classnames) {
             foreach ($model_classnames as $model_classname => $extra_fields) {
                 foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+                    $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;
                         }
                     }
                 }
@@ -139,7 +139,7 @@ 
             $model_changes = array();
             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;
@@ -161,7 +161,7 @@ 
             $resource_changes = array();
             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;
@@ -212,7 +212,7 @@ 
             foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $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]);
                     }
                 }
             }
@@ -237,7 +237,7 @@ 
     public function isModelNameInThisVersion($model_name)
     {
         $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
+        if (isset($model_names[$model_name])) {
             return true;
         } else {
             return false;
@@ -280,7 +280,7 @@ 
      */
     public function fieldsOnModelInThisVersion($model)
     {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+        if ( ! isset($this->cached_fields_on_models[$model->get_this_model_name()])) {
             // get all model changes between the requested version and current core version
             $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
             // fetch all fields currently on this model
@@ -288,12 +288,12 @@ 
             // remove all fields that have been added since
             foreach ($changes as $version => $changes_in_version) {
                 if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== 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()])
                     );
                 }
             }
@@ -448,7 +448,7 @@ 
         $relations = array();
         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

Indentation +437 added lines, -437 removed lines

@@ -20,441 +20,441 @@
  */
 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';
-
-    /**
-     * Top-level keys are versions (major and minor version numbers, eg "4.6")
-     * next-level keys are model names (eg "Event") that underwent some change in that version
-     * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
-     * or it's an array where the values are model field names,
-     * or API resource properties (ie, non-model fields that appear in REST API results)
-     * If a version is missing then we don't know anything about what changes it introduced from the previous version
-     *
-     * @var array
-     */
-    protected $model_changes = array();
-
-    /**
-     * top-level keys are version numbers,
-     * next-level keys are model CLASSNAMES (even parent classnames),
-     * and next-level keys are extra resource properties to attach to those models' resources,
-     * and next-level key-value pairs, where the keys are:
-     * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
-     *
-     * @var array
-     */
-    protected $resource_changes = array();
-
-    /**
-     * @var string indicating what version of the API was requested
-     * (eg although core might be at version 4.8.11, they may have sent a request
-     * for 4.6)
-     */
-    protected $requested_version = null;
-
-    /**
-     * Keys are model names, values are their classnames.
-     * We cache this so we only need to calculate this once per request
-     *
-     * @var array
-     */
-    protected $cached_models_for_requested_version = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_model_changes_between_requested_version_and_current = null;
-
-    /**
-     * @var array
-     */
-    protected $cached_resource_changes_between_requested_version_and_current = null;
-
-    /**
-     * 2d array where top-level keys are model names, 2nd-level keys are field names
-     * and values are the actual field objects
-     *
-     * @var array
-     */
-    protected $cached_fields_on_models = array();
-
-
-    /**
-     * Model_Version_Info constructor.
-     *
-     * @param string $requested_version
-     */
-    public function __construct($requested_version)
-    {
-        $this->requested_version = (string) $requested_version;
-        $this->model_changes = array(
-            '4.8.29' => array(
-                // first version where the REST API is in EE core, so no need
-                // to specify how its different from the previous
-            ),
-        );
-        // setup data for "extra" fields added onto resources which don't actually exist on models
-        $this->resource_changes = apply_filters(
-            'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
-            array()
-        );
-        $defaults = array(
-            'raw'              => false,
-            'type'             => 'N/A',
-            'nullable'         => true,
-            'table_alias'      => 'N/A',
-            'table_column'     => 'N/A',
-            'always_available' => true,
-        );
-        foreach ($this->resource_changes as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $extra_fields) {
-                foreach ($extra_fields as $fieldname => $field_data) {
-                    $this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
-                    foreach ($defaults as $attribute => $default_value) {
-                        if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
-                            $this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
-                        }
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Returns a slice of Model_Version_Info::model_changes()'s array
-     * indicating exactly what changes happened between the current core version,
-     * and the version requested
-     *
-     * @return array
-     */
-    public function modelChangesBetweenRequestedVersionAndCurrent()
-    {
-        if ($this->cached_model_changes_between_requested_version_and_current === null) {
-            $model_changes = array();
-            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()
-    {
-        if ($this->cached_resource_changes_between_requested_version_and_current === null) {
-            $resource_changes = array();
-            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()
-    {
-        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()
-    {
-        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()
-    {
-        if ($this->cached_models_for_requested_version === null) {
-            $all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
-            foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $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 = 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($model_name)
-    {
-        $model_names = $this->modelsForRequestedVersion();
-        if (isset($model_names[ $model_name ])) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
-     * version's models into account
-     *
-     * @param string $model_name
-     * @return \EEM_Base
-     * @throws \EE_Error
-     */
-    public function loadModel($model_name)
-    {
-        if ($this->isModelNameInThisVersion($model_name)) {
-            return EE_Registry::instance()->load_model($model_name);
-        } else {
-            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($model)
-    {
-        if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
-            // get all model changes between the requested version and current core version
-            $changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
-            // fetch all fields currently on this model
-            $current_fields = $model->field_settings();
-            // remove all fields that have been added since
-            foreach ($changes as $version => $changes_in_version) {
-                if (
-                    isset($changes_in_version[ $model->get_this_model_name() ])
-                    && $changes_in_version[ $model->get_this_model_name() ] !== 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, $classnames)
-    {
-        foreach ($classnames as $classname) {
-            if (is_a($object, $classname)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Returns the list of model field classes that that the API basically ignores
-     *
-     * @return array
-     */
-    public function fieldsIgnored()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read_fields_ignored',
-            array()
-        );
-    }
-
-
-    /**
-     * If this field one that should be ignored by the API?
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldIsIgnored($field_obj)
-    {
-        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()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_raw',
-            array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a raw format
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasRenderedFormat($field_obj)
-    {
-        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()
-    {
-        return apply_filters(
-            'FHEE__Controller_Model_Read__fields_pretty',
-            array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
-        );
-    }
-
-
-    /**
-     * If this field one that has a pretty equivalent
-     *
-     * @param EE_Model_Field_Base
-     * @return boolean
-     */
-    public function fieldHasPrettyFormat($field_obj)
-    {
-        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()
-    {
-        return $this->resource_changes;
-    }
-
-
-    /**
-     * Returns an array where keys are extra resource properties in this version of the API,
-     * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
-     *
-     * @param \EEM_Base $model
-     * @return array
-     */
-    public function extraResourcePropertiesForModel($model)
-    {
-        $extra_properties = array();
-        foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
-            foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
-                if (is_subclass_of($model, $model_classname)) {
-                    $extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
-                }
-            }
-        }
-        return $extra_properties;
-    }
-
-
-    /**
-     * Gets all the related models for the specified model. It's good to use this
-     * in case this model didn't exist for this version or something
-     *
-     * @param \EEM_Base $model
-     * @return \EE_Model_Relation_Base[]
-     */
-    public function relationSettings(\EEM_Base $model)
-    {
-        $relations = array();
-        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 apply_filters(
-            'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
-            $relations,
-            $model
-        );
-    }
+	/**
+	 * Constant used in the $_model_changes array to indicate that a model
+	 * was completely new in this version
+	 */
+	const MODEL_ADDED = 'model_added_in_this_version';
+
+	/**
+	 * Top-level keys are versions (major and minor version numbers, eg "4.6")
+	 * next-level keys are model names (eg "Event") that underwent some change in that version
+	 * and the value is either Model_Version_Info::model_added (indicating the model is completely NEW in this version),
+	 * or it's an array where the values are model field names,
+	 * or API resource properties (ie, non-model fields that appear in REST API results)
+	 * If a version is missing then we don't know anything about what changes it introduced from the previous version
+	 *
+	 * @var array
+	 */
+	protected $model_changes = array();
+
+	/**
+	 * top-level keys are version numbers,
+	 * next-level keys are model CLASSNAMES (even parent classnames),
+	 * and next-level keys are extra resource properties to attach to those models' resources,
+	 * and next-level key-value pairs, where the keys are:
+	 * 'raw', 'type', 'nullable', 'table_alias', 'table_column',  'always_available'
+	 *
+	 * @var array
+	 */
+	protected $resource_changes = array();
+
+	/**
+	 * @var string indicating what version of the API was requested
+	 * (eg although core might be at version 4.8.11, they may have sent a request
+	 * for 4.6)
+	 */
+	protected $requested_version = null;
+
+	/**
+	 * Keys are model names, values are their classnames.
+	 * We cache this so we only need to calculate this once per request
+	 *
+	 * @var array
+	 */
+	protected $cached_models_for_requested_version = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_model_changes_between_requested_version_and_current = null;
+
+	/**
+	 * @var array
+	 */
+	protected $cached_resource_changes_between_requested_version_and_current = null;
+
+	/**
+	 * 2d array where top-level keys are model names, 2nd-level keys are field names
+	 * and values are the actual field objects
+	 *
+	 * @var array
+	 */
+	protected $cached_fields_on_models = array();
+
+
+	/**
+	 * Model_Version_Info constructor.
+	 *
+	 * @param string $requested_version
+	 */
+	public function __construct($requested_version)
+	{
+		$this->requested_version = (string) $requested_version;
+		$this->model_changes = array(
+			'4.8.29' => array(
+				// first version where the REST API is in EE core, so no need
+				// to specify how its different from the previous
+			),
+		);
+		// setup data for "extra" fields added onto resources which don't actually exist on models
+		$this->resource_changes = apply_filters(
+			'FHEE__Model_Version_Info___construct__extra_resource_properties_for_models',
+			array()
+		);
+		$defaults = array(
+			'raw'              => false,
+			'type'             => 'N/A',
+			'nullable'         => true,
+			'table_alias'      => 'N/A',
+			'table_column'     => 'N/A',
+			'always_available' => true,
+		);
+		foreach ($this->resource_changes as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $extra_fields) {
+				foreach ($extra_fields as $fieldname => $field_data) {
+					$this->resource_changes[ $model_classname ][ $fieldname ]['name'] = $fieldname;
+					foreach ($defaults as $attribute => $default_value) {
+						if (! isset($this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ])) {
+							$this->resource_changes[ $model_classname ][ $fieldname ][ $attribute ] = $default_value;
+						}
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Returns a slice of Model_Version_Info::model_changes()'s array
+	 * indicating exactly what changes happened between the current core version,
+	 * and the version requested
+	 *
+	 * @return array
+	 */
+	public function modelChangesBetweenRequestedVersionAndCurrent()
+	{
+		if ($this->cached_model_changes_between_requested_version_and_current === null) {
+			$model_changes = array();
+			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()
+	{
+		if ($this->cached_resource_changes_between_requested_version_and_current === null) {
+			$resource_changes = array();
+			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()
+	{
+		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()
+	{
+		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()
+	{
+		if ($this->cached_models_for_requested_version === null) {
+			$all_models_in_current_version = EE_Registry::instance()->non_abstract_db_models;
+			foreach ($this->modelChangesBetweenRequestedVersionAndCurrent() as $version => $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 = 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($model_name)
+	{
+		$model_names = $this->modelsForRequestedVersion();
+		if (isset($model_names[ $model_name ])) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Wrapper for EE_Registry::instance()->load_model(), but takes the requested
+	 * version's models into account
+	 *
+	 * @param string $model_name
+	 * @return \EEM_Base
+	 * @throws \EE_Error
+	 */
+	public function loadModel($model_name)
+	{
+		if ($this->isModelNameInThisVersion($model_name)) {
+			return EE_Registry::instance()->load_model($model_name);
+		} else {
+			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($model)
+	{
+		if (! isset($this->cached_fields_on_models[ $model->get_this_model_name() ])) {
+			// get all model changes between the requested version and current core version
+			$changes = $this->modelChangesBetweenRequestedVersionAndCurrent();
+			// fetch all fields currently on this model
+			$current_fields = $model->field_settings();
+			// remove all fields that have been added since
+			foreach ($changes as $version => $changes_in_version) {
+				if (
+					isset($changes_in_version[ $model->get_this_model_name() ])
+					&& $changes_in_version[ $model->get_this_model_name() ] !== 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, $classnames)
+	{
+		foreach ($classnames as $classname) {
+			if (is_a($object, $classname)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Returns the list of model field classes that that the API basically ignores
+	 *
+	 * @return array
+	 */
+	public function fieldsIgnored()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read_fields_ignored',
+			array()
+		);
+	}
+
+
+	/**
+	 * If this field one that should be ignored by the API?
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldIsIgnored($field_obj)
+	{
+		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()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_raw',
+			array('EE_Post_Content_Field', 'EE_Full_HTML_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a raw format
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasRenderedFormat($field_obj)
+	{
+		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()
+	{
+		return apply_filters(
+			'FHEE__Controller_Model_Read__fields_pretty',
+			array('EE_Enum_Integer_Field', 'EE_Enum_Text_Field', 'EE_Money_Field')
+		);
+	}
+
+
+	/**
+	 * If this field one that has a pretty equivalent
+	 *
+	 * @param EE_Model_Field_Base
+	 * @return boolean
+	 */
+	public function fieldHasPrettyFormat($field_obj)
+	{
+		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()
+	{
+		return $this->resource_changes;
+	}
+
+
+	/**
+	 * Returns an array where keys are extra resource properties in this version of the API,
+	 * and values are key-value pairs describing the new properties. @see Model_Version::_resource_changes
+	 *
+	 * @param \EEM_Base $model
+	 * @return array
+	 */
+	public function extraResourcePropertiesForModel($model)
+	{
+		$extra_properties = array();
+		foreach ($this->resourceChangesBetweenRequestedVersionAndCurrent() as $version => $model_classnames) {
+			foreach ($model_classnames as $model_classname => $properties_added_in_this_version) {
+				if (is_subclass_of($model, $model_classname)) {
+					$extra_properties = array_merge($extra_properties, $properties_added_in_this_version);
+				}
+			}
+		}
+		return $extra_properties;
+	}
+
+
+	/**
+	 * Gets all the related models for the specified model. It's good to use this
+	 * in case this model didn't exist for this version or something
+	 *
+	 * @param \EEM_Base $model
+	 * @return \EE_Model_Relation_Base[]
+	 */
+	public function relationSettings(\EEM_Base $model)
+	{
+		$relations = array();
+		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 apply_filters(
+			'FHEE__Read__create_entity_from_wpdb_result__related_models_to_include',
+			$relations,
+			$model
+		);
+	}
 }

core/libraries/messages/EE_Messages_Base.lib.php

Spacing +9 added lines, -9 removed lines

@@ -196,11 +196,11 @@ 
             ! empty($messenger)
             && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
         ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+            $settings_to_use = $active_messengers[$messenger]['settings'][$messenger.'-message_types'];
         }
 
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
+        $this->_existing_admin_settings = isset($settings_to_use[$this->name]['settings'])
+            ? $settings_to_use[$this->name]['settings']
             : null;
     }
 
@@ -240,7 +240,7 @@ 
     public function get_valid_shortcodes()
     {
         $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+            'FHEE__'.get_class($this).'__get_valid_shortcodes',
             $this->_valid_shortcodes,
             $this
         );
@@ -283,19 +283,19 @@ 
     protected function _get_admin_page_content($page, $action, $extra, $actives)
     {
         // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
+        if ( ! empty($action)) {
+            $page = $page.'_'.$action;
         }
 
-        if (!isset($this->admin_registered_pages[ $page ])) {
+        if ( ! isset($this->admin_registered_pages[$page])) {
             // todo: a place to throw an exception?
             // We need to indicate there is no registered page so this function is not being called correctly.
             return false;
         }
         // k made it here so let's call the method
         $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
+            array($this, '_get_admin_content_'.$page),
+            array($actives, $extra)
         );
         if ($content === false) {
             // todo this needs to be an exception once we've got exceptions in place.

Indentation +265 added lines, -265 removed lines

@@ -13,44 +13,44 @@ 
  */
 abstract class EE_Messages_Base extends EE_Base
 {
-    /** DETAILS PROPERTIES **/
-    /**
-     * The following are used to hold details on the type for reference (i.e. on admin screens)
-     * and also used by the EE_message_type object to figure out where to get template data.
-     */
-    public $name;
-    public $description;
-    protected $_messages_item_type; // messenger OR message_type?
-
-
-    /**
-     * This is an array describing the ui facing labels
-     * that will be used whenever the messenger is referenced in the ui
-     *
-     * array(
-     *  'singular' => esc_html__('something'),
-     *  'plural' => esc_html__('somethings')
-     * )
-     *
-     * @var array
-     */
-    public $label;
-
-
-
-
-    /**
-     * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
-     * (and used to determine which callback method to call from the child class)
-     *
-     * structure should be
-     * array(
-     * 'page_action' => true
-     * )
-     *
+	/** DETAILS PROPERTIES **/
+	/**
+	 * The following are used to hold details on the type for reference (i.e. on admin screens)
+	 * and also used by the EE_message_type object to figure out where to get template data.
+	 */
+	public $name;
+	public $description;
+	protected $_messages_item_type; // messenger OR message_type?
+
+
+	/**
+	 * This is an array describing the ui facing labels
+	 * that will be used whenever the messenger is referenced in the ui
+	 *
+	 * array(
+	 *  'singular' => esc_html__('something'),
+	 *  'plural' => esc_html__('somethings')
+	 * )
+	 *
+	 * @var array
+	 */
+	public $label;
+
+
+
+
+	/**
+	 * This property when set will hold the slugs of all EE admin pages that we will need to retrieve fields for
+	 * (and used to determine which callback method to call from the child class)
+	 *
+	 * structure should be
+	 * array(
+	 * 'page_action' => true
+	 * )
+	 *
 *@var array
-     */
-    public $admin_registered_pages = array();
+	 */
+	public $admin_registered_pages = array();
 
 
 
@@ -59,265 +59,265 @@ 
 
 
 
-    /**
-     * this property holds any specific fields for holding any settings related to a messenger (if any needed)
-     * @var array
-     */
-    protected $_admin_settings_fields = array();
+	/**
+	 * this property holds any specific fields for holding any settings related to a messenger (if any needed)
+	 * @var array
+	 */
+	protected $_admin_settings_fields = array();
 
 
 
 
 
-    /**
-     * this property will hold any existing settings that may have been set in the admin.
-     * @var array
-     */
-    protected $_existing_admin_settings = array();
+	/**
+	 * this property will hold any existing settings that may have been set in the admin.
+	 * @var array
+	 */
+	protected $_existing_admin_settings = array();
 
 
 
 
 
-    /**
-     * this property will hold an array of valid shortcodes for this message type and messengers.
-     * #For Message Types:
-     * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
-     * For example:
-     * array( 'admin' => array('transaction', 'event', 'attendee') )
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the admin context;
-     *
-     *
-     * #For Messengers:
-     * For example:
-     * array('subject' => array('transaction', 'event', 'attendee'))
-     * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
-     * for the 'subject' field;
-     * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
-     * that field will inherit whatever are set as valid shortcodes by message_type.
-     * This is so messenger can set specific valid codes for fields and leave other
-     * valid shortcodes up to the message type matched with the messenger.
-     *
-     * @access protected
-     * @var array
-     */
-    protected $_valid_shortcodes = array();
+	/**
+	 * this property will hold an array of valid shortcodes for this message type and messengers.
+	 * #For Message Types:
+	 * This is an array of strings that correspond to defined EE_Shortcode libraries and per context.
+	 * For example:
+	 * array( 'admin' => array('transaction', 'event', 'attendee') )
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the admin context;
+	 *
+	 *
+	 * #For Messengers:
+	 * For example:
+	 * array('subject' => array('transaction', 'event', 'attendee'))
+	 * corresponds to 'EE_Transaction_Shortcodes.lib.php, EE_Event_Shortcodes.lib.php, EE_Attendee_Shortcodes.lib.php'
+	 * for the 'subject' field;
+	 * NOTE:  by default, with messengers, if the valid shortcodes for a field is left blank,
+	 * that field will inherit whatever are set as valid shortcodes by message_type.
+	 * This is so messenger can set specific valid codes for fields and leave other
+	 * valid shortcodes up to the message type matched with the messenger.
+	 *
+	 * @access protected
+	 * @var array
+	 */
+	protected $_valid_shortcodes = array();
 
 
 
 
 
-    public function __construct()
-    {
-        $this->_set_admin_settings_fields();
-        $this->_set_valid_shortcodes();
-        $this->_set_admin_pages();
-    }
+	public function __construct()
+	{
+		$this->_set_admin_settings_fields();
+		$this->_set_valid_shortcodes();
+		$this->_set_admin_pages();
+	}
 
 
 
 
 
-    /**
-     * sets the _admin_settings_fields property which needs to be defined by child classes.
-     * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
-     * array(
-     *      {field_name - also used for setting index} => array(
-     *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
-     *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
-     *          'required' => {bool, required or not},
-     *          'validation' => {bool, true if we want validation, false if not},
-     *          'format' => {%d, or %s},
-     *          'label' => {label for the field, make sure it's localized},
-     *          'default' => {default value for the setting}
-     *      ),
-     * );
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_settings_fields();
+	/**
+	 * sets the _admin_settings_fields property which needs to be defined by child classes.
+	 * You will want to set the _admin_settings_fields properties as a multi-dimensional array with the following format
+	 * array(
+	 *      {field_name - also used for setting index} => array(
+	 *          'field_type' => {type of field: 'text', 'textarea', 'checkbox'},
+	 *          'value_type' => {type of value: 'string', 'int', 'array', 'bool'},
+	 *          'required' => {bool, required or not},
+	 *          'validation' => {bool, true if we want validation, false if not},
+	 *          'format' => {%d, or %s},
+	 *          'label' => {label for the field, make sure it's localized},
+	 *          'default' => {default value for the setting}
+	 *      ),
+	 * );
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_settings_fields();
 
 
 
 
 
-    /**
-     * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
-     * Child classes have to define this method but don't necessarily have to set the flags
-     * as they will be set to false by default.
-     *
-     * Child classes use this method to set the `_admin_registered_page` property.
-     * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
-     * so Message Type/messenger fields/content is included on that admin page.
-     *
-     * @abstract
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_admin_pages();
+	/**
+	 * sets any properties on whether a message type or messenger interface shows up on a ee administration page.
+	 * Child classes have to define this method but don't necessarily have to set the flags
+	 * as they will be set to false by default.
+	 *
+	 * Child classes use this method to set the `_admin_registered_page` property.
+	 * That property is to indicate what EE admin pages we have a corresponding callback for in the child class
+	 * so Message Type/messenger fields/content is included on that admin page.
+	 *
+	 * @abstract
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_admin_pages();
 
 
 
 
 
-    /**
-     * Child classes must declare the $_valid_shortcodes property using this method.
-     * See comments for $_valid_shortcodes property for details on what it is used for.
-     *
-     * @access protected
-     * @return void
-     */
-    abstract protected function _set_valid_shortcodes();
+	/**
+	 * Child classes must declare the $_valid_shortcodes property using this method.
+	 * See comments for $_valid_shortcodes property for details on what it is used for.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	abstract protected function _set_valid_shortcodes();
 
 
 
-    /**
-     * sets the _existing_admin_settings property can be overridden by child classes.
-     * We do this so we only do database calls if needed.
-     *
-     * @access protected
-     * @param string $messenger
-     */
-    protected function _set_existing_admin_settings($messenger = '')
-    {
-        /** @var EE_Message_Resource_Manager $Message_Resource_Manager */
-        $Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
-        $active_messengers = $Message_Resource_Manager->get_active_messengers_option();
-        $settings_to_use = $active_messengers;
-
-        /**
-         * This determines what will be used for the getting the settings.
-         */
-        if (
-            ! empty($messenger)
-            && $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
-        ) {
-            $settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
-        }
-
-        $this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
-            ? $settings_to_use[ $this->name ]['settings']
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * get_existing_admin_settings
-     * (if needed) sets and returns the _existing_admin_settings property.
-     *
-     * @access public
-     * @param string $messenger
-     * @return array          settings
-     */
-    public function get_existing_admin_settings($messenger = '')
-    {
-        // if admin_settings property empty lets try setting it.
-        if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
-            $this->_set_existing_admin_settings($messenger);
-        }
-        return property_exists($this, '_existing_admin_settings')
-            ? $this->_existing_admin_settings
-            : null;
-    }
-
-
-
-
-
-
-    /**
-     * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
-     * @return array   an array of valid shortcodes.
-     */
-    public function get_valid_shortcodes()
-    {
-        $valid_shortcodes = apply_filters(
-            'FHEE__' . get_class($this) . '__get_valid_shortcodes',
-            $this->_valid_shortcodes,
-            $this
-        );
-        // The below filter applies to ALL messengers and message types so use with care!
-        $valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
-        return $valid_shortcodes;
-    }
-
-
-
-
-    /**
-     * getter that returns the protected admin_settings_fields property
-     *
-     * @access public
-     * @return array admin settings fields
-     */
-    public function get_admin_settings_fields()
-    {
-        return $this->_admin_settings_fields;
-    }
-
-
-
-
-
-    /**
-     * this public method accepts a page slug (for an EE_admin page)
-     * and will return the response from the child class callback function
-     * if that page is registered via the `_admin_registered_page` property set by the child class.
-     *
-     * @param string $page the slug of the EE admin page
-     * @param array $actives an array of active message type (or messenger) objects.
-     * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
-     * @param array $extra This is just an extra argument that can be used
-     *                     to pass additional data for setting up page content.
-     * @access protected
-     * @return string $content for page.
-     */
-    protected function _get_admin_page_content($page, $action, $extra, $actives)
-    {
-        // we can also further refine the context by action (if present).
-        if (!empty($action)) {
-            $page = $page . '_' . $action;
-        }
-
-        if (!isset($this->admin_registered_pages[ $page ])) {
-            // todo: a place to throw an exception?
-            // We need to indicate there is no registered page so this function is not being called correctly.
-            return false;
-        }
-        // k made it here so let's call the method
-        $content = call_user_func_array(
-            array( $this, '_get_admin_content_' . $page ),
-            array( $actives, $extra )
-        );
-        if ($content === false) {
-            // todo this needs to be an exception once we've got exceptions in place.
-            return false;
-        }
-        return $content;
-    }
-
-
-    /**
-     * Allows a message type to specifically exclude template fields for the provided messenger.
-     * Filtered so this can be programmatically altered as well.
-     * @param string $messenger_name name of messenger
-     * @return array
-     */
-    public function excludedFieldsForMessenger($messenger_name)
-    {
-        return apply_filters(
-            'FHEE__EE_Messages_Base__excludedFieldForMessenger',
-            array(),
-            $messenger_name,
-            $this->name,
-            $this
-        );
-    }
+	/**
+	 * sets the _existing_admin_settings property can be overridden by child classes.
+	 * We do this so we only do database calls if needed.
+	 *
+	 * @access protected
+	 * @param string $messenger
+	 */
+	protected function _set_existing_admin_settings($messenger = '')
+	{
+		/** @var EE_Message_Resource_Manager $Message_Resource_Manager */
+		$Message_Resource_Manager = EE_Registry::instance()->load_lib('Message_Resource_Manager');
+		$active_messengers = $Message_Resource_Manager->get_active_messengers_option();
+		$settings_to_use = $active_messengers;
+
+		/**
+		 * This determines what will be used for the getting the settings.
+		 */
+		if (
+			! empty($messenger)
+			&& $Message_Resource_Manager->is_message_type_active_for_messenger($messenger, $this->name)
+		) {
+			$settings_to_use = $active_messengers[ $messenger ]['settings'][ $messenger . '-message_types' ];
+		}
+
+		$this->_existing_admin_settings = isset($settings_to_use[ $this->name ]['settings'])
+			? $settings_to_use[ $this->name ]['settings']
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * get_existing_admin_settings
+	 * (if needed) sets and returns the _existing_admin_settings property.
+	 *
+	 * @access public
+	 * @param string $messenger
+	 * @return array          settings
+	 */
+	public function get_existing_admin_settings($messenger = '')
+	{
+		// if admin_settings property empty lets try setting it.
+		if (method_exists($this, '_set_existing_admin_settings') && empty($this->_existing_admin_settings)) {
+			$this->_set_existing_admin_settings($messenger);
+		}
+		return property_exists($this, '_existing_admin_settings')
+			? $this->_existing_admin_settings
+			: null;
+	}
+
+
+
+
+
+
+	/**
+	 * This returns the array of valid shortcodes for a message type or messenger as set by the child in the $_valid_shortcode property.
+	 * @return array   an array of valid shortcodes.
+	 */
+	public function get_valid_shortcodes()
+	{
+		$valid_shortcodes = apply_filters(
+			'FHEE__' . get_class($this) . '__get_valid_shortcodes',
+			$this->_valid_shortcodes,
+			$this
+		);
+		// The below filter applies to ALL messengers and message types so use with care!
+		$valid_shortcodes = apply_filters('FHEE__EE_Messages_Base__get_valid_shortcodes', $valid_shortcodes, $this);
+		return $valid_shortcodes;
+	}
+
+
+
+
+	/**
+	 * getter that returns the protected admin_settings_fields property
+	 *
+	 * @access public
+	 * @return array admin settings fields
+	 */
+	public function get_admin_settings_fields()
+	{
+		return $this->_admin_settings_fields;
+	}
+
+
+
+
+
+	/**
+	 * this public method accepts a page slug (for an EE_admin page)
+	 * and will return the response from the child class callback function
+	 * if that page is registered via the `_admin_registered_page` property set by the child class.
+	 *
+	 * @param string $page the slug of the EE admin page
+	 * @param array $actives an array of active message type (or messenger) objects.
+	 * @param string $action the page action (to allow for more specific handling - i.e. edit vs. add pages)
+	 * @param array $extra This is just an extra argument that can be used
+	 *                     to pass additional data for setting up page content.
+	 * @access protected
+	 * @return string $content for page.
+	 */
+	protected function _get_admin_page_content($page, $action, $extra, $actives)
+	{
+		// we can also further refine the context by action (if present).
+		if (!empty($action)) {
+			$page = $page . '_' . $action;
+		}
+
+		if (!isset($this->admin_registered_pages[ $page ])) {
+			// todo: a place to throw an exception?
+			// We need to indicate there is no registered page so this function is not being called correctly.
+			return false;
+		}
+		// k made it here so let's call the method
+		$content = call_user_func_array(
+			array( $this, '_get_admin_content_' . $page ),
+			array( $actives, $extra )
+		);
+		if ($content === false) {
+			// todo this needs to be an exception once we've got exceptions in place.
+			return false;
+		}
+		return $content;
+	}
+
+
+	/**
+	 * Allows a message type to specifically exclude template fields for the provided messenger.
+	 * Filtered so this can be programmatically altered as well.
+	 * @param string $messenger_name name of messenger
+	 * @return array
+	 */
+	public function excludedFieldsForMessenger($messenger_name)
+	{
+		return apply_filters(
+			'FHEE__EE_Messages_Base__excludedFieldForMessenger',
+			array(),
+			$messenger_name,
+			$this->name,
+			$this
+		);
+	}
 }

core/libraries/messages/data_class/EE_Messages_incoming_data.core.php

Spacing +47 added lines, -47 removed lines

@@ -332,7 +332,7 @@ 
         $answers            = $questions = $attendees = $line_items = $registrations = array();
         $total_ticket_count = 0;
 
-        if (! empty($this->reg_objs)) {
+        if ( ! empty($this->reg_objs)) {
             $event_attendee_count = array();
             /** @var EE_Registration $reg */
             foreach ($this->reg_objs as $reg) {
@@ -344,7 +344,7 @@ 
 
                 $evt_id = $reg->event_ID();
                 /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
+                $ticket = $reg->get_first_related('Ticket');
                 $attendee = $reg->attendee();
                 $event = $reg->event();
                 // if none of the following entities are available, then we can't setup other data reliably,
@@ -358,67 +358,67 @@ 
                 }
                 $relateddatetime = $ticket->datetimes();
                 $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
+                $tickets[$ticket->ID()]['ticket']                        = $ticket;
+                $tickets[$ticket->ID()]['count']                         = is_array($tickets[$ticket->ID()])
+                                                                           && isset($tickets[$ticket->ID()]['count'])
+                    ? $tickets[$ticket->ID()]['count'] + 1
                     : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
+                $tickets[$ticket->ID()]['att_objs'][$attendee->ID()] = $attendee;
+                $tickets[$ticket->ID()]['dtt_objs']                      = $relateddatetime;
+                $tickets[$ticket->ID()]['reg_objs'][$reg->ID()]          = $reg;
+                $tickets[$ticket->ID()]['EE_Event']                      = $event;
+                $evtcache[$evt_id]                                       = $event;
+                $eventsetup[$evt_id]['reg_objs'][$reg->ID()]             = $reg;
+                $eventsetup[$evt_id]['tkt_objs'][$ticket->ID()]          = $ticket;
+                $eventsetup[$evt_id]['att_objs'][$attendee->ID()] = $attendee;
+                $event_attendee_count[$evt_id]                           = isset($event_attendee_count[$evt_id])
+                    ? $event_attendee_count[$evt_id] + 1
                     : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+                $attendees[$reg->attendee_ID()]['line_ref'][]            = $evt_id;
+                $attendees[$reg->attendee_ID()]['att_obj']               = $attendee;
+                $attendees[$reg->attendee_ID()]['reg_objs'][$reg->ID()]  = $reg;
                 // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+                $attendees[$reg->attendee_ID()]['attendee_email']          = $attendee->email();
+                $attendees[$reg->attendee_ID()]['tkt_objs'][$ticket->ID()] = $ticket;
+                $attendees[$reg->attendee_ID()]['evt_objs'][$evt_id]       = $event;
 
                 // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
+                $registrations[$reg->ID()]['tkt_obj'] = $ticket;
+                $registrations[$reg->ID()]['evt_obj'] = $event;
+                $registrations[$reg->ID()]['reg_obj'] = $reg;
+                $registrations[$reg->ID()]['att_obj'] = $attendee;
 
                 // set up answer objects
                 $rel_ans = $reg->get_many_related('Answer');
                 foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
+                    if ( ! isset($questions[$ansid])) {
+                        $questions[$ansid] = $answer->get_first_related('Question');
                     }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+                    $answers[$ansid] = $answer;
+                    $registrations[$reg->ID()]['ans_objs'][$ansid] = $answer;
                 }
                 /**
                  * @var int $dtt_id
                  * @var EE_Datetime $datetime
                  */
                 foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+                    $eventsetup[$evt_id]['dtt_objs'][$dtt_id]       = $datetime;
+                    $registrations[$reg->ID()]['dtt_objs'][$dtt_id] = $datetime;
 
-                    if (isset($datetimes[ $dtt_id ])) {
+                    if (isset($datetimes[$dtt_id])) {
                         continue; // already have this info in the datetimes array.
                     }
 
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+                    $datetimes[$dtt_id]['tkt_objs'][]           = $ticket;
+                    $datetimes[$dtt_id]['datetime']             = $datetime;
+                    $datetimes[$dtt_id]['evt_objs'][$evt_id]    = $event;
+                    $datetimes[$dtt_id]['reg_objs'][$reg->ID()] = $reg;
                 }
             }
 
             // let's loop through the unique event=>reg items and setup data on them
 
-            if (! empty($eventsetup)) {
+            if ( ! empty($eventsetup)) {
                 foreach ($eventsetup as $evt_id => $items) {
                     $ticket_line_items_for_event = array();
                     if ($this->txn instanceof EE_Transaction) {
@@ -432,11 +432,11 @@ 
                             )
                         );
                     }
-                    $events[ $evt_id ] = array(
+                    $events[$evt_id] = array(
                         'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
+                        'event'           => $evtcache[$evt_id],
+                        'name'            => $evtcache[$evt_id] instanceof EE_Event ? $evtcache[$evt_id]->name() : '',
+                        'total_attendees' => $event_attendee_count[$evt_id],
                         'reg_objs'        => $items['reg_objs'],
                         'tkt_objs'        => $items['tkt_objs'],
                         'att_objs'        => $items['att_objs'],
@@ -447,11 +447,11 @@ 
                     // make sure the tickets have the line items setup for them.
                     foreach ($ticket_line_items_for_event as $line_id => $line_item) {
                         // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+                        if ($line_item instanceof EE_Line_Item && isset($tickets[$line_item->ticket()->ID()])) {
+                            $tickets[$line_item->ticket()->ID()]['line_item']      = $line_item;
+                            $tickets[$line_item->ticket()->ID()]['sub_line_items'] = $line_item->children();
+                            $line_items[$line_item->ID()]['children']              = $line_item->children();
+                            $line_items[$line_item->ID()]['EE_Ticket']             = $line_item->ticket();
                         }
                     }
                 }

Indentation +518 added lines, -518 removed lines

@@ -16,522 +16,522 @@
  */
 abstract class EE_Messages_incoming_data
 {
-    /**
-     * user id for logged in user when data collected
-     *
-     * @var string $user_id
-     */
-    public $user_id;
-
-    /**
-     * IP Address of browser used
-     *
-     * @var string $ip_address
-     */
-    public $ip_address;
-
-    /**
-     * browser
-     *
-     * @var string $user_agent
-     */
-    public $user_agent;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $init_access
-     */
-    public $init_access;
-
-    /**
-     * Unix timestamp
-     *
-     * @var string $last_access
-     */
-    public $last_access;
-
-    /**
-     * The registrations details from the cart
-     *
-     * @var array $reg_info
-     */
-    public $reg_info;
-
-    /**
-     * Some data handlers can set what reg status all the registrations are filtered by.
-     * The status should match a EEM_Registration status constant.
-     *
-     * @var string $filtered_reg_status
-     */
-    public $filtered_reg_status;
-
-    /**
-     * will hold an array of events assembled from $reg_info
-     *
-     * @var EE_Event[] $events
-     */
-    public $events;
-
-    /**
-     * holds an array of datetimes assembled from the incoming data.
-     *
-     * @var EE_Datetime[] $datetimes
-     */
-    public $datetimes;
-
-    /**
-     * holds an array of tickets assembled from the incoming data.
-     *
-     * @var EE_Ticket[] $tickets
-     */
-    public $tickets;
-
-    /**
-     * holds an array with a key of parent line item and values are an array of children of that line item.
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $line_items_with_children
-     */
-    public $line_items_with_children;
-
-    /**
-     * will hold an array of attendees assembled from the $reg_info
-     *
-     * @var EE_Attendee[] $attendees
-     */
-    public $attendees;
-
-    /**
-     * will hold an array of cached registration objects and info assembled from reg_info
-     *
-     * @var array $registrations
-     */
-    public $registrations;
-
-    /**
-     * will hold an array of answers assembled from the $reg_info
-     *
-     * @var EE_Answer[] $answers
-     */
-    public $answers;
-
-    /**
-     * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
-     *
-     * @var EE_Question[] $questions
-     */
-    public $questions;
-
-    /**
-     * Will hold billing data assembled from $billing_info (if present)
-     *
-     * @var mixed (array|null) $billing
-     */
-    public $billing;
-
-    /**
-     * The total amount of tax for the transaction
-     *
-     * @var float $taxes
-     */
-    public $taxes;
-
-    /**
-     * Holds the line items related to taxes
-     *
-     * @since 4.5.0
-     * @var EE_Line_Item[] $tax_line_items
-     */
-    public $tax_line_items;
-
-    /**
-     * Hold the line items which aren't taxes and don't relate
-     * to tickets. So: promotions and miscellaneous charges
-     *
-     * @since 4.5
-     * @var EE_Line_Item[] $additional_line_items
-     */
-    public $additional_line_items;
-
-    /**
-     * Holds the grand total EE_Line_Item
-     *
-     * @var EE_Line_Item $grand_total_line_item
-     */
-    public $grand_total_line_item;
-
-    /**
-     * holds the grand total price object
-     * currently not used.
-     *
-     * @var null $grand_total_price_object
-     */
-    public $grand_total_price_object;
-
-    /**
-     * total number of tickets
-     *
-     * @var int $total_ticket_count
-     */
-    public $total_ticket_count;
-
-    /**
-     * Will hold the final transaction object (EE_Transaction)
-     *
-     * @var EE_Transaction $txn
-     */
-    public $txn;
-
-    /**
-     * Holds the payments related to a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment[] $payments
-     */
-    public $payments;
-
-    /**
-     * Holds the first related payment related for a transaction
-     *
-     * @since 4.5.0
-     * @var EE_Payment $payment
-     */
-    public $payment;
-
-    /**
-     * Will hold the label for the txn status
-     *
-     * @var string $txn_status
-     */
-    public $txn_status;
-
-    /**
-     * Will hold the final registration object (EE_Registration)
-     *
-     * @var EE_Registration[] $reg_objs
-     */
-    public $reg_objs;
-
-    /**
-     * Will hold an array of primary attendee data (if present)
-     *
-     * @var array $primary_attendee_data
-     */
-    public $primary_attendee_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $_data
-     */
-    protected $_data;
-
-    /**
-     * This is just an internal object used for passing around the incoming data.
-     *
-     * @var mixed $incoming_data
-     */
-    public $incoming_data;
-
-    /**
-     * hold objects that might be created
-     *
-     * @type EE_Registration $reg_obj
-     */
-    public $reg_obj;
-
-
-    /**
-     * constructor
-     *
-     * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
-     *                    data object.  But here parent will be generic because we don't know what's coming in.
-     */
-    public function __construct($data)
-    {
-        $this->_data = $data;
-        $this->_setup_data();
-    }
-
-
-    /**
-     * Every child class has to setup the data object !
-     *
-     * @return void
-     */
-    abstract protected function _setup_data();
-
-
-    /**
-     * Returns database safe representation of the data later used to when instantiating this object.
-     *
-     * @param mixed $data The incoming data to be prepped.
-     * @return mixed   The prepped data for db
-     */
-    public static function convert_data_for_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
-     * can be sent into this method and converted back into the format used for instantiating with this data handler.
-     *
-     * @param $data
-     * @return mixed
-     */
-    public static function convert_data_from_persistent_storage($data)
-    {
-        return $data;
-    }
-
-
-    /**
-     * only purpose is to return the data
-     *
-     * @access public
-     * @return mixed the formatted data object!
-     */
-    public function data()
-    {
-        return $this->_data;
-    }
-
-
-    /**
-     * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
-     * is that $this->reg_objs be set.
-     *
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     * @throws EntityNotFoundException
-     */
-    protected function _assemble_data()
-    {
-        // verify that reg_objs is set
-        if (
-            ! is_array($this->reg_objs)
-            && ! reset($this->reg_objs) instanceof EE_Registration
-        ) {
-            throw new EE_Error(
-                esc_html__(
-                    'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
-                    'event_espresso'
-                )
-            );
-        }
-
-        // get all attendee and events associated with the registrations in this transaction
-        $events             = $event_setup = $evtcache = $tickets = $datetimes = array();
-        $answers            = $questions = $attendees = $line_items = $registrations = array();
-        $total_ticket_count = 0;
-
-        if (! empty($this->reg_objs)) {
-            $event_attendee_count = array();
-            /** @var EE_Registration $reg */
-            foreach ($this->reg_objs as $reg) {
-                if (
-                    $this->_skip_registration_for_processing($reg)
-                ) {
-                    continue;
-                }
-
-                $evt_id = $reg->event_ID();
-                /** @type EE_Ticket $ticket */
-                $ticket          = $reg->get_first_related('Ticket');
-                $attendee = $reg->attendee();
-                $event = $reg->event();
-                // if none of the following entities are available, then we can't setup other data reliably,
-                // so let's just skip.
-                if (
-                    ! $ticket instanceof EE_Ticket
-                    || ! $attendee instanceof EE_Attendee
-                    || ! $event instanceof EE_Event
-                ) {
-                    continue;
-                }
-                $relateddatetime = $ticket->datetimes();
-                $total_ticket_count++;
-                $tickets[ $ticket->ID() ]['ticket']                        = $ticket;
-                $tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
-                                                                           && isset($tickets[ $ticket->ID() ]['count'])
-                    ? $tickets[ $ticket->ID() ]['count'] + 1
-                    : 1;
-                $tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
-                $tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
-                $tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
-                $tickets[ $ticket->ID() ]['EE_Event']                      = $event;
-                $evtcache[ $evt_id ]                                       = $event;
-                $eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
-                $eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
-                $eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
-                $event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
-                    ? $event_attendee_count[ $evt_id ] + 1
-                    : 0;
-                $attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
-                $attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
-                $attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
-                // $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
-                $attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
-                $attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
-                $attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
-
-                // registrations
-                $registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
-                $registrations[ $reg->ID() ]['evt_obj'] = $event;
-                $registrations[ $reg->ID() ]['reg_obj'] = $reg;
-                $registrations[ $reg->ID() ]['att_obj'] = $attendee;
-
-                // set up answer objects
-                $rel_ans = $reg->get_many_related('Answer');
-                foreach ($rel_ans as $ansid => $answer) {
-                    if (! isset($questions[ $ansid ])) {
-                        $questions[ $ansid ] = $answer->get_first_related('Question');
-                    }
-                    $answers[ $ansid ]                               = $answer;
-                    $registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
-                }
-                /**
-                 * @var int $dtt_id
-                 * @var EE_Datetime $datetime
-                 */
-                foreach ($relateddatetime as $dtt_id => $datetime) {
-                    $eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
-                    $registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
-
-                    if (isset($datetimes[ $dtt_id ])) {
-                        continue; // already have this info in the datetimes array.
-                    }
-
-                    $datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
-                    $datetimes[ $dtt_id ]['datetime']             = $datetime;
-                    $datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
-                    $datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
-                }
-            }
-
-            // let's loop through the unique event=>reg items and setup data on them
-
-            if (! empty($eventsetup)) {
-                foreach ($eventsetup as $evt_id => $items) {
-                    $ticket_line_items_for_event = array();
-                    if ($this->txn instanceof EE_Transaction) {
-                        $ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
-                            array(
-                                array(
-                                    'Ticket.Datetime.EVT_ID' => $evt_id,
-                                    'TXN_ID'                 => $this->txn->ID(),
-                                ),
-                                'default_where_conditions' => 'none',
-                            )
-                        );
-                    }
-                    $events[ $evt_id ] = array(
-                        'ID'              => $evt_id,
-                        'event'           => $evtcache[ $evt_id ],
-                        'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
-                        'total_attendees' => $event_attendee_count[ $evt_id ],
-                        'reg_objs'        => $items['reg_objs'],
-                        'tkt_objs'        => $items['tkt_objs'],
-                        'att_objs'        => $items['att_objs'],
-                        'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
-                        'line_items'      => $ticket_line_items_for_event,
-                    );
-
-                    // make sure the tickets have the line items setup for them.
-                    foreach ($ticket_line_items_for_event as $line_id => $line_item) {
-                        // only add the ticket line items if we already have this ticket in the $tickets array.
-                        if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
-                            $tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
-                            $tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
-                            $line_items[ $line_item->ID() ]['children']              = $line_item->children();
-                            $line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
-                        }
-                    }
-                }
-            }
-
-            $this->grand_total_line_item = $this->txn instanceof EE_Transaction
-                ? $this->txn->total_line_item()
-                : null;
-        }
-
-        // lets set the attendees and events properties
-        $this->attendees                = $attendees;
-        $this->events                   = $events;
-        $this->tickets                  = $tickets;
-        $this->line_items_with_children = $line_items;
-        $this->datetimes                = $datetimes;
-        $this->questions                = $questions;
-        $this->answers                  = $answers;
-        $this->total_ticket_count       = $total_ticket_count;
-        $this->registrations            = $registrations;
-
-        if ($this->txn instanceof EE_Transaction) {
-            $this->tax_line_items        = $this->txn->tax_items();
-            $this->additional_line_items = $this->txn->non_ticket_line_items();
-            $this->payments              = $this->txn->payments();
-
-            // setup primary registration if we have a single transaction object to work with
-
-            // let's get just the primary_attendee_data!  First we get the primary registration object.
-            $primary_reg = $this->txn->primary_registration();
-            // verify
-            if ($primary_reg instanceof EE_Registration) {
-                // get attendee object
-                if ($primary_reg->attendee() instanceof EE_Attendee) {
-                    // now we can setup the primary_attendee_data array
-                    $this->primary_attendee_data = array(
-                        'registration_id' => $primary_reg->ID(),
-                        'att_obj'         => $primary_reg->attendee(),
-                        'reg_obj'         => $primary_reg,
-                        'primary_att_obj' => $primary_reg->attendee(),
-                        'primary_reg_obj' => $primary_reg,
-                    );
-                } else {
-                    EE_Error::add_error(
-                        esc_html__(
-                            'Incoming data does not have a valid Attendee object for the primary registrant.',
-                            'event_espresso'
-                        ),
-                        __FILE__,
-                        __FUNCTION__,
-                        __LINE__
-                    );
-                }
-            } else {
-                EE_Error::add_error(
-                    esc_html__(
-                        'Incoming data does not have a valid Registration object for the primary registrant.',
-                        'event_espresso'
-                    ),
-                    __FILE__,
-                    __FUNCTION__,
-                    __LINE__
-                );
-            }
-        }
-    }
-
-    /**
-     * This simply considers whether the given registration should be processed or not based on comparison with the
-     * filtered_reg_status property.
-     *
-     * @param EE_Registration $registration
-     * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
-     *               processing
-     */
-    protected function _skip_registration_for_processing(EE_Registration $registration)
-    {
-        if (empty($this->filtered_reg_status)) {
-            return false;
-        }
-
-        // if we made it here then we just compare the filtered_reg_status with the registration status and return that
-        return $this->filtered_reg_status !== $registration->status_ID();
-    }
+	/**
+	 * user id for logged in user when data collected
+	 *
+	 * @var string $user_id
+	 */
+	public $user_id;
+
+	/**
+	 * IP Address of browser used
+	 *
+	 * @var string $ip_address
+	 */
+	public $ip_address;
+
+	/**
+	 * browser
+	 *
+	 * @var string $user_agent
+	 */
+	public $user_agent;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $init_access
+	 */
+	public $init_access;
+
+	/**
+	 * Unix timestamp
+	 *
+	 * @var string $last_access
+	 */
+	public $last_access;
+
+	/**
+	 * The registrations details from the cart
+	 *
+	 * @var array $reg_info
+	 */
+	public $reg_info;
+
+	/**
+	 * Some data handlers can set what reg status all the registrations are filtered by.
+	 * The status should match a EEM_Registration status constant.
+	 *
+	 * @var string $filtered_reg_status
+	 */
+	public $filtered_reg_status;
+
+	/**
+	 * will hold an array of events assembled from $reg_info
+	 *
+	 * @var EE_Event[] $events
+	 */
+	public $events;
+
+	/**
+	 * holds an array of datetimes assembled from the incoming data.
+	 *
+	 * @var EE_Datetime[] $datetimes
+	 */
+	public $datetimes;
+
+	/**
+	 * holds an array of tickets assembled from the incoming data.
+	 *
+	 * @var EE_Ticket[] $tickets
+	 */
+	public $tickets;
+
+	/**
+	 * holds an array with a key of parent line item and values are an array of children of that line item.
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $line_items_with_children
+	 */
+	public $line_items_with_children;
+
+	/**
+	 * will hold an array of attendees assembled from the $reg_info
+	 *
+	 * @var EE_Attendee[] $attendees
+	 */
+	public $attendees;
+
+	/**
+	 * will hold an array of cached registration objects and info assembled from reg_info
+	 *
+	 * @var array $registrations
+	 */
+	public $registrations;
+
+	/**
+	 * will hold an array of answers assembled from the $reg_info
+	 *
+	 * @var EE_Answer[] $answers
+	 */
+	public $answers;
+
+	/**
+	 * will hold an array of questions assembled from the $reg_info (indexed by Answer ID);
+	 *
+	 * @var EE_Question[] $questions
+	 */
+	public $questions;
+
+	/**
+	 * Will hold billing data assembled from $billing_info (if present)
+	 *
+	 * @var mixed (array|null) $billing
+	 */
+	public $billing;
+
+	/**
+	 * The total amount of tax for the transaction
+	 *
+	 * @var float $taxes
+	 */
+	public $taxes;
+
+	/**
+	 * Holds the line items related to taxes
+	 *
+	 * @since 4.5.0
+	 * @var EE_Line_Item[] $tax_line_items
+	 */
+	public $tax_line_items;
+
+	/**
+	 * Hold the line items which aren't taxes and don't relate
+	 * to tickets. So: promotions and miscellaneous charges
+	 *
+	 * @since 4.5
+	 * @var EE_Line_Item[] $additional_line_items
+	 */
+	public $additional_line_items;
+
+	/**
+	 * Holds the grand total EE_Line_Item
+	 *
+	 * @var EE_Line_Item $grand_total_line_item
+	 */
+	public $grand_total_line_item;
+
+	/**
+	 * holds the grand total price object
+	 * currently not used.
+	 *
+	 * @var null $grand_total_price_object
+	 */
+	public $grand_total_price_object;
+
+	/**
+	 * total number of tickets
+	 *
+	 * @var int $total_ticket_count
+	 */
+	public $total_ticket_count;
+
+	/**
+	 * Will hold the final transaction object (EE_Transaction)
+	 *
+	 * @var EE_Transaction $txn
+	 */
+	public $txn;
+
+	/**
+	 * Holds the payments related to a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment[] $payments
+	 */
+	public $payments;
+
+	/**
+	 * Holds the first related payment related for a transaction
+	 *
+	 * @since 4.5.0
+	 * @var EE_Payment $payment
+	 */
+	public $payment;
+
+	/**
+	 * Will hold the label for the txn status
+	 *
+	 * @var string $txn_status
+	 */
+	public $txn_status;
+
+	/**
+	 * Will hold the final registration object (EE_Registration)
+	 *
+	 * @var EE_Registration[] $reg_objs
+	 */
+	public $reg_objs;
+
+	/**
+	 * Will hold an array of primary attendee data (if present)
+	 *
+	 * @var array $primary_attendee_data
+	 */
+	public $primary_attendee_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $_data
+	 */
+	protected $_data;
+
+	/**
+	 * This is just an internal object used for passing around the incoming data.
+	 *
+	 * @var mixed $incoming_data
+	 */
+	public $incoming_data;
+
+	/**
+	 * hold objects that might be created
+	 *
+	 * @type EE_Registration $reg_obj
+	 */
+	public $reg_obj;
+
+
+	/**
+	 * constructor
+	 *
+	 * @param mixed $data incoming data object|array.  Suggested that child classes use type hinting for expected
+	 *                    data object.  But here parent will be generic because we don't know what's coming in.
+	 */
+	public function __construct($data)
+	{
+		$this->_data = $data;
+		$this->_setup_data();
+	}
+
+
+	/**
+	 * Every child class has to setup the data object !
+	 *
+	 * @return void
+	 */
+	abstract protected function _setup_data();
+
+
+	/**
+	 * Returns database safe representation of the data later used to when instantiating this object.
+	 *
+	 * @param mixed $data The incoming data to be prepped.
+	 * @return mixed   The prepped data for db
+	 */
+	public static function convert_data_for_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * Data that has been stored in persistent storage that was prepped by _convert_data_for_persistent_storage
+	 * can be sent into this method and converted back into the format used for instantiating with this data handler.
+	 *
+	 * @param $data
+	 * @return mixed
+	 */
+	public static function convert_data_from_persistent_storage($data)
+	{
+		return $data;
+	}
+
+
+	/**
+	 * only purpose is to return the data
+	 *
+	 * @access public
+	 * @return mixed the formatted data object!
+	 */
+	public function data()
+	{
+		return $this->_data;
+	}
+
+
+	/**
+	 * This helper method can be used by any incoming data handlers to setup the data correctly.  All that is required
+	 * is that $this->reg_objs be set.
+	 *
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 * @throws EntityNotFoundException
+	 */
+	protected function _assemble_data()
+	{
+		// verify that reg_objs is set
+		if (
+			! is_array($this->reg_objs)
+			&& ! reset($this->reg_objs) instanceof EE_Registration
+		) {
+			throw new EE_Error(
+				esc_html__(
+					'In order to assemble the data correctly, the "reg_objs" property must be an array of EE_Registration objects',
+					'event_espresso'
+				)
+			);
+		}
+
+		// get all attendee and events associated with the registrations in this transaction
+		$events             = $event_setup = $evtcache = $tickets = $datetimes = array();
+		$answers            = $questions = $attendees = $line_items = $registrations = array();
+		$total_ticket_count = 0;
+
+		if (! empty($this->reg_objs)) {
+			$event_attendee_count = array();
+			/** @var EE_Registration $reg */
+			foreach ($this->reg_objs as $reg) {
+				if (
+					$this->_skip_registration_for_processing($reg)
+				) {
+					continue;
+				}
+
+				$evt_id = $reg->event_ID();
+				/** @type EE_Ticket $ticket */
+				$ticket          = $reg->get_first_related('Ticket');
+				$attendee = $reg->attendee();
+				$event = $reg->event();
+				// if none of the following entities are available, then we can't setup other data reliably,
+				// so let's just skip.
+				if (
+					! $ticket instanceof EE_Ticket
+					|| ! $attendee instanceof EE_Attendee
+					|| ! $event instanceof EE_Event
+				) {
+					continue;
+				}
+				$relateddatetime = $ticket->datetimes();
+				$total_ticket_count++;
+				$tickets[ $ticket->ID() ]['ticket']                        = $ticket;
+				$tickets[ $ticket->ID() ]['count']                         = is_array($tickets[ $ticket->ID() ])
+																		   && isset($tickets[ $ticket->ID() ]['count'])
+					? $tickets[ $ticket->ID() ]['count'] + 1
+					: 1;
+				$tickets[ $ticket->ID() ]['att_objs'][ $attendee->ID() ] = $attendee;
+				$tickets[ $ticket->ID() ]['dtt_objs']                      = $relateddatetime;
+				$tickets[ $ticket->ID() ]['reg_objs'][ $reg->ID() ]          = $reg;
+				$tickets[ $ticket->ID() ]['EE_Event']                      = $event;
+				$evtcache[ $evt_id ]                                       = $event;
+				$eventsetup[ $evt_id ]['reg_objs'][ $reg->ID() ]             = $reg;
+				$eventsetup[ $evt_id ]['tkt_objs'][ $ticket->ID() ]          = $ticket;
+				$eventsetup[ $evt_id ]['att_objs'][ $attendee->ID() ]    = $attendee;
+				$event_attendee_count[ $evt_id ]                           = isset($event_attendee_count[ $evt_id ])
+					? $event_attendee_count[ $evt_id ] + 1
+					: 0;
+				$attendees[ $reg->attendee_ID() ]['line_ref'][]            = $evt_id;
+				$attendees[ $reg->attendee_ID() ]['att_obj']               = $attendee;
+				$attendees[ $reg->attendee_ID() ]['reg_objs'][ $reg->ID() ]  = $reg;
+				// $attendees[ $reg->attendee_ID() ]['registration_id'] = $reg->ID();
+				$attendees[ $reg->attendee_ID() ]['attendee_email']          = $attendee->email();
+				$attendees[ $reg->attendee_ID() ]['tkt_objs'][ $ticket->ID() ] = $ticket;
+				$attendees[ $reg->attendee_ID() ]['evt_objs'][ $evt_id ]       = $event;
+
+				// registrations
+				$registrations[ $reg->ID() ]['tkt_obj'] = $ticket;
+				$registrations[ $reg->ID() ]['evt_obj'] = $event;
+				$registrations[ $reg->ID() ]['reg_obj'] = $reg;
+				$registrations[ $reg->ID() ]['att_obj'] = $attendee;
+
+				// set up answer objects
+				$rel_ans = $reg->get_many_related('Answer');
+				foreach ($rel_ans as $ansid => $answer) {
+					if (! isset($questions[ $ansid ])) {
+						$questions[ $ansid ] = $answer->get_first_related('Question');
+					}
+					$answers[ $ansid ]                               = $answer;
+					$registrations[ $reg->ID() ]['ans_objs'][ $ansid ] = $answer;
+				}
+				/**
+				 * @var int $dtt_id
+				 * @var EE_Datetime $datetime
+				 */
+				foreach ($relateddatetime as $dtt_id => $datetime) {
+					$eventsetup[ $evt_id ]['dtt_objs'][ $dtt_id ]       = $datetime;
+					$registrations[ $reg->ID() ]['dtt_objs'][ $dtt_id ] = $datetime;
+
+					if (isset($datetimes[ $dtt_id ])) {
+						continue; // already have this info in the datetimes array.
+					}
+
+					$datetimes[ $dtt_id ]['tkt_objs'][]           = $ticket;
+					$datetimes[ $dtt_id ]['datetime']             = $datetime;
+					$datetimes[ $dtt_id ]['evt_objs'][ $evt_id ]    = $event;
+					$datetimes[ $dtt_id ]['reg_objs'][ $reg->ID() ] = $reg;
+				}
+			}
+
+			// let's loop through the unique event=>reg items and setup data on them
+
+			if (! empty($eventsetup)) {
+				foreach ($eventsetup as $evt_id => $items) {
+					$ticket_line_items_for_event = array();
+					if ($this->txn instanceof EE_Transaction) {
+						$ticket_line_items_for_event = EEM_Line_Item::instance()->get_all(
+							array(
+								array(
+									'Ticket.Datetime.EVT_ID' => $evt_id,
+									'TXN_ID'                 => $this->txn->ID(),
+								),
+								'default_where_conditions' => 'none',
+							)
+						);
+					}
+					$events[ $evt_id ] = array(
+						'ID'              => $evt_id,
+						'event'           => $evtcache[ $evt_id ],
+						'name'            => $evtcache[ $evt_id ] instanceof EE_Event ? $evtcache[ $evt_id ]->name() : '',
+						'total_attendees' => $event_attendee_count[ $evt_id ],
+						'reg_objs'        => $items['reg_objs'],
+						'tkt_objs'        => $items['tkt_objs'],
+						'att_objs'        => $items['att_objs'],
+						'dtt_objs'        => isset($items['dtt_objs']) ? $items['dtt_objs'] : array(),
+						'line_items'      => $ticket_line_items_for_event,
+					);
+
+					// make sure the tickets have the line items setup for them.
+					foreach ($ticket_line_items_for_event as $line_id => $line_item) {
+						// only add the ticket line items if we already have this ticket in the $tickets array.
+						if ($line_item instanceof EE_Line_Item && isset($tickets[ $line_item->ticket()->ID() ])) {
+							$tickets[ $line_item->ticket()->ID() ]['line_item']      = $line_item;
+							$tickets[ $line_item->ticket()->ID() ]['sub_line_items'] = $line_item->children();
+							$line_items[ $line_item->ID() ]['children']              = $line_item->children();
+							$line_items[ $line_item->ID() ]['EE_Ticket']             = $line_item->ticket();
+						}
+					}
+				}
+			}
+
+			$this->grand_total_line_item = $this->txn instanceof EE_Transaction
+				? $this->txn->total_line_item()
+				: null;
+		}
+
+		// lets set the attendees and events properties
+		$this->attendees                = $attendees;
+		$this->events                   = $events;
+		$this->tickets                  = $tickets;
+		$this->line_items_with_children = $line_items;
+		$this->datetimes                = $datetimes;
+		$this->questions                = $questions;
+		$this->answers                  = $answers;
+		$this->total_ticket_count       = $total_ticket_count;
+		$this->registrations            = $registrations;
+
+		if ($this->txn instanceof EE_Transaction) {
+			$this->tax_line_items        = $this->txn->tax_items();
+			$this->additional_line_items = $this->txn->non_ticket_line_items();
+			$this->payments              = $this->txn->payments();
+
+			// setup primary registration if we have a single transaction object to work with
+
+			// let's get just the primary_attendee_data!  First we get the primary registration object.
+			$primary_reg = $this->txn->primary_registration();
+			// verify
+			if ($primary_reg instanceof EE_Registration) {
+				// get attendee object
+				if ($primary_reg->attendee() instanceof EE_Attendee) {
+					// now we can setup the primary_attendee_data array
+					$this->primary_attendee_data = array(
+						'registration_id' => $primary_reg->ID(),
+						'att_obj'         => $primary_reg->attendee(),
+						'reg_obj'         => $primary_reg,
+						'primary_att_obj' => $primary_reg->attendee(),
+						'primary_reg_obj' => $primary_reg,
+					);
+				} else {
+					EE_Error::add_error(
+						esc_html__(
+							'Incoming data does not have a valid Attendee object for the primary registrant.',
+							'event_espresso'
+						),
+						__FILE__,
+						__FUNCTION__,
+						__LINE__
+					);
+				}
+			} else {
+				EE_Error::add_error(
+					esc_html__(
+						'Incoming data does not have a valid Registration object for the primary registrant.',
+						'event_espresso'
+					),
+					__FILE__,
+					__FUNCTION__,
+					__LINE__
+				);
+			}
+		}
+	}
+
+	/**
+	 * This simply considers whether the given registration should be processed or not based on comparison with the
+	 * filtered_reg_status property.
+	 *
+	 * @param EE_Registration $registration
+	 * @return bool  returning true means we DO want to skip processing.  returning false means we DON'T want to skip
+	 *               processing
+	 */
+	protected function _skip_registration_for_processing(EE_Registration $registration)
+	{
+		if (empty($this->filtered_reg_status)) {
+			return false;
+		}
+
+		// if we made it here then we just compare the filtered_reg_status with the registration status and return that
+		return $this->filtered_reg_status !== $registration->status_ID();
+	}
 }

core/libraries/shortcodes/EE_Primary_Registration_List_Shortcodes.lib.php

Spacing +11 added lines, -11 removed lines

@@ -83,7 +83,7 @@ 
     private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
@@ -97,7 +97,7 @@ 
                 'attendee',
             );
             $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+            $tkts = array($data->registrations[$registration->ID()]['tkt_obj']);
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
@@ -127,16 +127,16 @@ 
 
     private function _get_tickets_from_event(EE_Event $event, $reg = null)
     {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
+        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['tkt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_tkts = array();
             // return only tickets for the given attendee
             foreach ($evt_tkts as $tkt) {
                 if (
-                    isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+                    isset($this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj'])
+                    && $this->_extra_data['data']->registrations[$reg->ID()]['tkt_obj']->ID() == $tkt->ID()
                 ) {
                     $adj_tkts[] = $tkt;
                 }
@@ -172,14 +172,14 @@ 
     private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
     {
         $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
+        if ( ! $registration instanceof EE_Registration) {
             return '';
         }
         // setup valid shortcodes depending on what the status of the $this->_data property is
         if ($this->_data['data'] instanceof EE_Messages_Addressee) {
             $valid_shortcodes = array('datetime', 'attendee');
             $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+            $dtts = $data->registrations[$registration->ID()]['dtt_objs'];
             $data = $this->_data;
         } elseif ($this->_data['data'] instanceof EE_Event) {
             $valid_shortcodes = array('datetime', 'attendee');
@@ -206,14 +206,14 @@ 
 
     private function _get_datetimes_from_event(EE_Event $event, $reg = null)
     {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
+        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[$event->ID(
+        )]['dtt_objs'] : array();
 
         if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
             $adj_dtts = array();
             // return only dtts for the given attendee
             foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+                if (isset($this->_extra_data['data']->registrations[$reg->ID()]['dtt_objs'][$dtt->ID()])) {
                     $adj_dtts[] = $dtt;
                 }
             }

Indentation +200 added lines, -200 removed lines

@@ -18,204 +18,204 @@
  */
 class EE_Primary_Registration_List_Shortcodes extends EE_Shortcodes
 {
-    public function __construct()
-    {
-        parent::__construct();
-    }
-
-
-    protected function _init_props()
-    {
-        $this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
-        $this->description = esc_html__(
-            'All shortcodes specific primary registrant recipients list type data.',
-            'event_espresso'
-        );
-        $this->_shortcodes = array(
-            '[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
-                'Will output a list of tickets that the primary registration received.',
-                'event_espresso'
-            ),
-            '[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
-                'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
-                'event_espresso'
-            ),
-        );
-    }
-
-
-    protected function _parser($shortcode)
-    {
-        switch ($shortcode) {
-            case '[PRIMARY_REGISTRANT_TICKET_LIST]':
-                return $this->_get_recipient_ticket_list(true);
-
-            case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
-                return $this->_get_recipient_datetime_list(true);
-        }
-        return '';
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_ticket_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-    }
-
-
-    private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array(
-                'ticket',
-                'event_list',
-                'attendee_list',
-                'datetime_list',
-                'registration_details',
-                'attendee',
-            );
-            $template = $this->_data['template'];
-            $tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
-                ? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
-            // let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
-            $template = str_replace('[EVENT_LIST]', '', $template);
-            // data will be tickets for this event for this recipient.
-            $tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $tktparsed = '';
-        foreach ($tkts as $ticket) {
-            $tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
-                $template,
-                $ticket,
-                $valid_shortcodes,
-                $data
-            );
-        }
-        return $tktparsed;
-    }
-
-
-    private function _get_tickets_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['tkt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_tkts = array();
-            // return only tickets for the given attendee
-            foreach ($evt_tkts as $tkt) {
-                if (
-                    isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
-                    && $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
-                ) {
-                    $adj_tkts[] = $tkt;
-                }
-            }
-            $evt_tkts = $adj_tkts;
-        }
-        return $evt_tkts;
-    }
-
-
-    /**
-     * figure out what the incoming data is and then return the appropriate parsed value
-     *
-     * @param  boolean $primary whether we're getting the primary registrant ticket_list.
-     * @return string
-     */
-    private function _get_recipient_datetime_list($primary = false)
-    {
-        $this->_validate_list_requirements();
-
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-        } elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
-        } else {
-            return '';
-        }
-
-        return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
-    }
-
-
-    private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
-    {
-        $registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
-        if (! $registration instanceof EE_Registration) {
-            return '';
-        }
-        // setup valid shortcodes depending on what the status of the $this->_data property is
-        if ($this->_data['data'] instanceof EE_Messages_Addressee) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = $this->_data['template'];
-            $dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
-            $data = $this->_data;
-        } elseif ($this->_data['data'] instanceof EE_Event) {
-            $valid_shortcodes = array('datetime', 'attendee');
-            $template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
-                ? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
-            $dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
-            $data = $this->_extra_data;
-        } else {
-            return '';
-        }
-
-        $dtt_parsed = '';
-        foreach ($dtts as $datetime) {
-            $dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
-                $template,
-                $datetime,
-                $valid_shortcodes,
-                $this->_extra_data
-            );
-        }
-        return $dtt_parsed;
-    }
-
-
-    private function _get_datetimes_from_event(EE_Event $event, $reg = null)
-    {
-        $evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
-        ) ]['dtt_objs'] : array();
-
-        if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
-            $adj_dtts = array();
-            // return only dtts for the given attendee
-            foreach ($evt_dtts as $dtt) {
-                if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
-                    $adj_dtts[] = $dtt;
-                }
-            }
-            $evt_dtts = $adj_dtts;
-        }
-        return $evt_dtts;
-    }
+	public function __construct()
+	{
+		parent::__construct();
+	}
+
+
+	protected function _init_props()
+	{
+		$this->label = esc_html__('Primary Registrant List Shortcodes', 'event_espresso');
+		$this->description = esc_html__(
+			'All shortcodes specific primary registrant recipients list type data.',
+			'event_espresso'
+		);
+		$this->_shortcodes = array(
+			'[PRIMARY_REGISTRANT_TICKET_LIST]' => esc_html__(
+				'Will output a list of tickets that the primary registration received.',
+				'event_espresso'
+			),
+			'[PRIMARY_REGISTRANT_DATETIME_LIST]' => esc_html__(
+				'Will output a list of datetimes that the primary registrant for the transaction has been registered for.',
+				'event_espresso'
+			),
+		);
+	}
+
+
+	protected function _parser($shortcode)
+	{
+		switch ($shortcode) {
+			case '[PRIMARY_REGISTRANT_TICKET_LIST]':
+				return $this->_get_recipient_ticket_list(true);
+
+			case '[PRIMARY_REGISTRANT_DATETIME_LIST]':
+				return $this->_get_recipient_datetime_list(true);
+		}
+		return '';
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_ticket_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_ticket_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+	}
+
+
+	private function _get_recipient_ticket_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array(
+				'ticket',
+				'event_list',
+				'attendee_list',
+				'datetime_list',
+				'registration_details',
+				'attendee',
+			);
+			$template = $this->_data['template'];
+			$tkts = array($data->registrations[ $registration->ID() ]['tkt_obj']);
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('ticket', 'attendee_list', 'datetime_list', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['ticket_list'])
+				? $this->_data['template']['ticket_list'] : $this->_extra_data['template']['ticket_list'];
+			// let's remove any existing [EVENT_LIST] shortcode from the ticket list template so that we don't get recursion.
+			$template = str_replace('[EVENT_LIST]', '', $template);
+			// data will be tickets for this event for this recipient.
+			$tkts = $this->_get_tickets_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$tktparsed = '';
+		foreach ($tkts as $ticket) {
+			$tktparsed .= $this->_shortcode_helper->parse_ticket_list_template(
+				$template,
+				$ticket,
+				$valid_shortcodes,
+				$data
+			);
+		}
+		return $tktparsed;
+	}
+
+
+	private function _get_tickets_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_tkts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['tkt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_tkts = array();
+			// return only tickets for the given attendee
+			foreach ($evt_tkts as $tkt) {
+				if (
+					isset($this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj'])
+					&& $this->_extra_data['data']->registrations[ $reg->ID() ]['tkt_obj']->ID() == $tkt->ID()
+				) {
+					$adj_tkts[] = $tkt;
+				}
+			}
+			$evt_tkts = $adj_tkts;
+		}
+		return $evt_tkts;
+	}
+
+
+	/**
+	 * figure out what the incoming data is and then return the appropriate parsed value
+	 *
+	 * @param  boolean $primary whether we're getting the primary registrant ticket_list.
+	 * @return string
+	 */
+	private function _get_recipient_datetime_list($primary = false)
+	{
+		$this->_validate_list_requirements();
+
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+		} elseif ($this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			return $this->_get_recipient_datetime_list_parsed($this->_extra_data['data'], $primary);
+		} else {
+			return '';
+		}
+
+		return $this->_get_recipient_datetime_list_parsed($this->_data['data'], $primary);
+	}
+
+
+	private function _get_recipient_datetime_list_parsed(EE_Messages_Addressee $data, $primary = false)
+	{
+		$registration = $primary ? $data->primary_reg_obj : $data->reg_obj;
+		if (! $registration instanceof EE_Registration) {
+			return '';
+		}
+		// setup valid shortcodes depending on what the status of the $this->_data property is
+		if ($this->_data['data'] instanceof EE_Messages_Addressee) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = $this->_data['template'];
+			$dtts = $data->registrations[ $registration->ID() ]['dtt_objs'];
+			$data = $this->_data;
+		} elseif ($this->_data['data'] instanceof EE_Event) {
+			$valid_shortcodes = array('datetime', 'attendee');
+			$template = is_array($this->_data['template']) && isset($this->_data['template']['datetime_list'])
+				? $this->_data['template']['datetime_list'] : $this->_extra_data['template']['datetime_list'];
+			$dtts = $this->_get_datetimes_from_event($this->_data['data'], $registration);
+			$data = $this->_extra_data;
+		} else {
+			return '';
+		}
+
+		$dtt_parsed = '';
+		foreach ($dtts as $datetime) {
+			$dtt_parsed .= $this->_shortcode_helper->parse_datetime_list_template(
+				$template,
+				$datetime,
+				$valid_shortcodes,
+				$this->_extra_data
+			);
+		}
+		return $dtt_parsed;
+	}
+
+
+	private function _get_datetimes_from_event(EE_Event $event, $reg = null)
+	{
+		$evt_dtts = isset($this->_extra_data['data']->events) ? $this->_extra_data['data']->events[ $event->ID(
+		) ]['dtt_objs'] : array();
+
+		if ($reg instanceof EE_Registration && $this->_extra_data['data'] instanceof EE_Messages_Addressee) {
+			$adj_dtts = array();
+			// return only dtts for the given attendee
+			foreach ($evt_dtts as $dtt) {
+				if (isset($this->_extra_data['data']->registrations[ $reg->ID() ]['dtt_objs'][ $dtt->ID() ])) {
+					$adj_dtts[] = $dtt;
+				}
+			}
+			$evt_dtts = $adj_dtts;
+		}
+		return $evt_dtts;
+	}
 }

core/libraries/form_sections/inputs/EE_Select_Reveal_Input.input.php

Spacing +5 added lines, -5 removed lines

@@ -45,12 +45,12 @@ 
             if (empty($sibling_section_name)) {
                 continue;
             }
-            $sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
+            $sibling_section = $this->find_section_from_path('../'.$sibling_section_name);
             if (
                 $sibling_section instanceof EE_Form_Section_Base
                 && ! empty($sibling_section_name)
             ) {
-                $sibling_sections[ $sibling_section_name ] = $sibling_section;
+                $sibling_sections[$sibling_section_name] = $sibling_section;
             }
         }
         return $sibling_sections;
@@ -66,14 +66,14 @@ 
     public function get_other_js_data($form_other_js_data = array())
     {
         $form_other_js_data = parent::get_other_js_data($form_other_js_data);
-        if (! isset($form_other_js_data['select_reveal_inputs'])) {
+        if ( ! isset($form_other_js_data['select_reveal_inputs'])) {
             $form_other_js_data['select_reveal_inputs'] = array();
         }
         $sibling_input_to_html_id_map = array();
         foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
-            $sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
+            $sibling_input_to_html_id_map[$sibling_section_path] = $sibling_section->html_id();
         }
-        $form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
+        $form_other_js_data['select_reveal_inputs'][$this->html_id()] = $sibling_input_to_html_id_map;
         return $form_other_js_data;
     }
 }

Indentation +59 added lines, -59 removed lines

@@ -14,65 +14,65 @@
  */
 class EE_Select_Reveal_Input extends EE_Select_Input
 {
-    /**
-     * @param array $answer_options Array keys which match a sibling section's name
-     *              will show/unhide that sibling subsection. Otherwise, siblings whose names
-     *              match array keys of $answer_options are hidden.
-     *              Note: internally each array key is considered a relative form input path
-     *              (see EE_Form_Section_Base::find_section_from_path) but relative
-     *              to THIS INPUT's PARENT section, not this input itself. ie,
-     *              a '../' is automatically added onto each each array key, to produce
-     *              the relative form input path.
-     *              Note however: array keys which are an EMPTY STRING are left as-is
-     *
-     * @param array $input_settings
-     */
-    public function __construct($answer_options, $input_settings = array())
-    {
-        parent::__construct($answer_options, $input_settings);
-    }
+	/**
+	 * @param array $answer_options Array keys which match a sibling section's name
+	 *              will show/unhide that sibling subsection. Otherwise, siblings whose names
+	 *              match array keys of $answer_options are hidden.
+	 *              Note: internally each array key is considered a relative form input path
+	 *              (see EE_Form_Section_Base::find_section_from_path) but relative
+	 *              to THIS INPUT's PARENT section, not this input itself. ie,
+	 *              a '../' is automatically added onto each each array key, to produce
+	 *              the relative form input path.
+	 *              Note however: array keys which are an EMPTY STRING are left as-is
+	 *
+	 * @param array $input_settings
+	 */
+	public function __construct($answer_options, $input_settings = array())
+	{
+		parent::__construct($answer_options, $input_settings);
+	}
 
-    /**
-     * Gets all the sibling sections controlled by this reveal select input
-     * @return \EE_Form_Section_Base[] keys are their form section paths
-     */
-    public function sibling_sections_controlled()
-    {
-        $sibling_sections = array();
-        foreach ($this->options() as $sibling_section_name => $sibling_section) {
-            // if it's an empty string just leave it alone
-            if (empty($sibling_section_name)) {
-                continue;
-            }
-            $sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
-            if (
-                $sibling_section instanceof EE_Form_Section_Base
-                && ! empty($sibling_section_name)
-            ) {
-                $sibling_sections[ $sibling_section_name ] = $sibling_section;
-            }
-        }
-        return $sibling_sections;
-    }
+	/**
+	 * Gets all the sibling sections controlled by this reveal select input
+	 * @return \EE_Form_Section_Base[] keys are their form section paths
+	 */
+	public function sibling_sections_controlled()
+	{
+		$sibling_sections = array();
+		foreach ($this->options() as $sibling_section_name => $sibling_section) {
+			// if it's an empty string just leave it alone
+			if (empty($sibling_section_name)) {
+				continue;
+			}
+			$sibling_section = $this->find_section_from_path('../' . $sibling_section_name);
+			if (
+				$sibling_section instanceof EE_Form_Section_Base
+				&& ! empty($sibling_section_name)
+			) {
+				$sibling_sections[ $sibling_section_name ] = $sibling_section;
+			}
+		}
+		return $sibling_sections;
+	}
 
-    /**
-     * Adds an entry of 'select_reveal_inputs' to the js data, which is an array
-     * whose top-level keys are select reveal input html ids; values are arrays
-     * whose keys are select option values and values are the sections they reveal
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = array())
-    {
-        $form_other_js_data = parent::get_other_js_data($form_other_js_data);
-        if (! isset($form_other_js_data['select_reveal_inputs'])) {
-            $form_other_js_data['select_reveal_inputs'] = array();
-        }
-        $sibling_input_to_html_id_map = array();
-        foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
-            $sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
-        }
-        $form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
-        return $form_other_js_data;
-    }
+	/**
+	 * Adds an entry of 'select_reveal_inputs' to the js data, which is an array
+	 * whose top-level keys are select reveal input html ids; values are arrays
+	 * whose keys are select option values and values are the sections they reveal
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = array())
+	{
+		$form_other_js_data = parent::get_other_js_data($form_other_js_data);
+		if (! isset($form_other_js_data['select_reveal_inputs'])) {
+			$form_other_js_data['select_reveal_inputs'] = array();
+		}
+		$sibling_input_to_html_id_map = array();
+		foreach ($this->sibling_sections_controlled() as $sibling_section_path => $sibling_section) {
+			$sibling_input_to_html_id_map[ $sibling_section_path ] = $sibling_section->html_id();
+		}
+		$form_other_js_data['select_reveal_inputs'][ $this->html_id() ] = $sibling_input_to_html_id_map;
+		return $form_other_js_data;
+	}
 }