eventespresso / event-espresso-core

core/libraries/rest_api/ModelDataTranslator.php

Unused Use Statements -2 removed lines

@@ -2,11 +2,9 @@
 namespace EventEspresso\core\libraries\rest_api;
 
 use DomainException;
-use EE_Capabilities;
 use EE_Datetime_Field;
 use EE_Error;
 use EE_Infinite_Integer_Field;
-use EE_Maybe_Serialized_Simple_HTML_Field;
 use EE_Model_Field_Base;
 use EE_Serialized_Text_Field;
 use EEM_Base;

Indentation +834 added lines, -834 removed lines

@@ -12,7 +12,7 @@ 
 use EEM_Base;
 
 if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -37,837 +37,837 @@ 
 class ModelDataTranslator
 {
 
-    /**
-     * We used to use -1 for infinity in the rest api, but that's ambiguous for
-     * fields that COULD contain -1; so we use null
-     */
-    const EE_INF_IN_REST = null;
-
-
-
-    /**
-     * Prepares a possible array of input values from JSON for use by the models
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $requested_version
-     * @param string               $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     */
-    public static function prepareFieldValuesFromJson(
-        $field_obj,
-        $original_value_maybe_array,
-        $requested_version,
-        $timezone_string = 'UTC'
-    ) {
-        if (is_array($original_value_maybe_array)
-            && ! $field_obj instanceof EE_Serialized_Text_Field
-        ) {
-            $new_value_maybe_array = array();
-            foreach ($original_value_maybe_array as $array_key => $array_item) {
-                $new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
-                    $field_obj,
-                    $array_item,
-                    $requested_version,
-                    $timezone_string
-                );
-            }
-        } else {
-            $new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $requested_version,
-                $timezone_string
-            );
-        }
-        return $new_value_maybe_array;
-    }
-
-
-
-    /**
-     * Prepares an array of field values FOR use in JSON/REST API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value_maybe_array
-     * @param string               $request_version (eg 4.8.36)
-     * @return array
-     */
-    public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
-    {
-        if (is_array($original_value_maybe_array)) {
-            $new_value = array();
-            foreach ($original_value_maybe_array as $key => $value) {
-                $new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
-            }
-        } else {
-            $new_value = ModelDataTranslator::prepareFieldValueForJson(
-                $field_obj,
-                $original_value_maybe_array,
-                $request_version
-            );
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * Prepares incoming data from the json or $_REQUEST parameters for the models'
-     * "$query_params".
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed               $original_value
-     * @param string              $requested_version
-     * @param string              $timezone_string treat values as being in this timezone
-     * @return mixed
-     * @throws RestException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public static function prepareFieldValueFromJson(
-        $field_obj,
-        $original_value,
-        $requested_version,
-        $timezone_string = 'UTC' // UTC
-    ) {
-        //check if they accidentally submitted an error value. If so throw an exception
-        if (is_array($original_value)
-            && isset($original_value['error_code'], $original_value['error_message'])) {
-            throw new RestException(
-                'rest_submitted_error_value',
-                sprintf(
-                    esc_html__(
-                        'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
-                        'event_espresso'
-                    ),
-                    $field_obj->get_name()
-                ),
-                array(
-                    'status' => 400,
-                )
-            );
-        }
-        //double-check for serialized PHP. We never accept serialized PHP. No way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        $timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
-        $new_value = null;
-        //walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
-        // way Jose.
-        ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
-        if ($field_obj instanceof EE_Infinite_Integer_Field
-            && in_array($original_value, array(null, ''), true)
-        ) {
-            $new_value = EE_INF;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            $new_value = rest_parse_date(
-                self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
-            );
-            if ($new_value === false) {
-                throw new RestException(
-                    'invalid_format_for_timestamp',
-                    sprintf(
-                        esc_html__(
-                            'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
-                            'event_espresso'
-                        ),
-                        'RFC3339',
-                        'ISO8601',
-                        $original_value
-                    ),
-                    array(
-                        'status' => 400
-                    )
-                );
-            }
-        } else {
-            $new_value = $original_value;
-        }
-        return $new_value;
-    }
-
-
-    /**
-     * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
-     * information via details obtained from the host site.
-     *
-     * @param string            $original_timestamp
-     * @param EE_Datetime_Field $datetime_field
-     * @param                   $timezone_string
-     * @return string
-     * @throws DomainException
-     */
-    private static function getTimestampWithTimezoneOffset(
-        $original_timestamp,
-        EE_Datetime_Field $datetime_field,
-        $timezone_string
-    ) {
-        //already have timezone information?
-        if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
-            //yes, we're ignoring the timezone.
-            return $original_timestamp;
-        }
-        //need to append timezone
-        list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
-            $datetime_field->get_timezone_offset(
-                new \DateTimeZone($timezone_string),
-                $original_timestamp
-            )
-        );
-        $offset_string =
-            str_pad(
-                floor($offset_secs / HOUR_IN_SECONDS),
-                2,
-                '0',
-                STR_PAD_LEFT
-            )
-            . ':'
-            . str_pad(
-                ($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
-                2,
-                '0',
-                STR_PAD_LEFT
-            );
-        return $original_timestamp . $offset_sign . $offset_string;
-    }
-
-
-
-    /**
-     * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
-     * think that can happen). If $data is an array, recurses into its keys and values
-     * @param mixed $data
-     * @throws RestException
-     * @return void
-     */
-    public static function throwExceptionIfContainsSerializedData($data)
-    {
-        if (is_array($data)) {
-            foreach ($data as $key => $value) {
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
-                ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
-            }
-        } else {
-            if (is_serialized($data) || is_object($data)) {
-                throw new RestException(
-                    'serialized_data_submission_prohibited',
-                    esc_html__(
-                        // @codingStandardsIgnoreStart
-                        'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
-                        // @codingStandardsIgnoreEnd
-                        'event_espresso'
-                    )
-                );
-            }
-        }
-    }
-
-
-
-    /**
-     * determines what's going on with them timezone strings
-     *
-     * @param int $timezone_offset
-     * @return array
-     */
-    private static function parseTimezoneOffset($timezone_offset)
-    {
-        $first_char = substr((string)$timezone_offset, 0, 1);
-        if ($first_char === '+' || $first_char === '-') {
-            $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
-        } else {
-            $offset_sign = '+';
-            $offset_secs = $timezone_offset;
-        }
-        return array($offset_sign, $offset_secs);
-    }
-
-
-
-    /**
-     * Prepares a field's value for display in the API
-     *
-     * @param EE_Model_Field_Base $field_obj
-     * @param mixed                $original_value
-     * @param string               $requested_version
-     * @return mixed
-     */
-    public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
-    {
-        if ($original_value === EE_INF) {
-            $new_value = ModelDataTranslator::EE_INF_IN_REST;
-        } elseif ($field_obj instanceof EE_Datetime_Field) {
-            if (is_string($original_value)) {
-                //did they submit a string of a unix timestamp?
-                if (is_numeric($original_value)) {
-                    $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int)$original_value);
-                } else {
-                    //first, check if its a MySQL timestamp in GMT
-                    $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
-                }
-                if (! $datetime_obj instanceof \DateTime) {
-                    //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
-                    $datetime_obj = $field_obj->prepare_for_set($original_value);
-                }
-                $original_value = $datetime_obj;
-            }
-            if ($original_value instanceof \DateTime) {
-                $new_value = $original_value->format('Y-m-d H:i:s');
-            } elseif (is_int($original_value) || is_float($original_value)) {
-                $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif($original_value === null || $original_value === '') {
-                $new_value = null;
-            } else {
-                //so it's not a datetime object, unix timestamp (as string or int),
-                //MySQL timestamp, or even a string in the field object's format. So no idea what it is
-                throw new \EE_Error(
-                    sprintf(
-                        esc_html__(
-                        // @codingStandardsIgnoreStart
-                            'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
-                            // @codingStandardsIgnoreEnd
-                            'event_espressso'
-                        ),
-                        $original_value,
-                        $field_obj->get_name(),
-                        $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
-                    )
-                );
-            }
-            $new_value = mysql_to_rfc3339($new_value);
-        } else {
-            $new_value = $original_value;
-        }
-        //are we about to send an object? just don't. We have no good way to represent it in JSON.
-        // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
-            $new_value = array(
-                'error_code' => 'php_object_not_return',
-                'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
-            $new_value,
-            $field_obj,
-            $original_value,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares condition-query-parameters (like what's in where and having) from
-     * the format expected in the API to use in the models
-     *
-     * @param array     $inputted_query_params_of_this_type
-     * @param EEM_Base $model
-     * @param string    $requested_version
-     * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
-     *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
-     *                         and we also won't accept serialized data unless the current user has unfiltered_html.
-     * @return array
-     * @throws DomainException
-     * @throws RestException
-     * @throws EE_Error
-     */
-    public static function prepareConditionsQueryParamsForModels(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version,
-        $writing = false
-    ) {
-        $query_param_for_models = array();
-        $valid_operators = $model->valid_operators();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $is_gmt_datetime_field = false;
-            $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-                $query_param_key
-            );
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                $query_param_sans_stars,
-                $model
-            );
-            //double-check is it a *_gmt field?
-            if (! $field instanceof EE_Model_Field_Base
-                && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
-            ) {
-                //yep, take off '_gmt', and find the field
-                $query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
-                $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                    $query_param_key,
-                    $model
-                );
-                $timezone = 'UTC';
-                $is_gmt_datetime_field = true;
-            } elseif ($field instanceof EE_Datetime_Field) {
-                //so it's not a GMT field. Set the timezone on the model to the default
-                $timezone = \EEH_DTT_Helper::get_valid_timezone_string();
-            } else {
-                //just keep using what's already set for the timezone
-                $timezone = $model->get_timezone();
-            }
-            if ($field instanceof EE_Model_Field_Base) {
-                if (! $writing && is_array($query_param_value)) {
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'numerically_indexed_array_of_values_only',
-                                sprintf(
-                                    esc_html__(
-                                        'The array provided for the parameter "%1$s" should be numerically indexed.',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                    }
-                    //did they specify an operator?
-                    if (isset($query_param_value[0])
-                        && isset($valid_operators[$query_param_value[0]])
-                    ) {
-                        $op = $query_param_value[0];
-                        $translated_value = array($op);
-                        if (array_key_exists($op, $model->valid_in_style_operators())
-                            && isset($query_param_value[1])
-                            && ! isset($query_param_value[2])
-                        ) {
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } elseif (array_key_exists($op, $model->valid_between_style_operators())
-                            && isset($query_param_value[1], $query_param_value[2])
-                            && !isset($query_param_value[3])
-                        ) {
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[2],
-                                $requested_version,
-                                $timezone
-                            );
-                        } elseif (array_key_exists($op, $model->valid_like_style_operators())
-                            && isset($query_param_value[1])
-                            && ! isset($query_param_value[2])
-                        ) {
-                            //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 (array_key_exists($op, $model->valid_null_style_operators())
-                            && !isset($query_param_value[1])) {
-                            //no arguments should have been provided, so don't look for any
-                        } elseif (isset($query_param_value[1])
-                            && !isset($query_param_value[2])
-                            && ! array_key_exists(
-                                $op,
-                                array_merge(
-                                    $model->valid_in_style_operators(),
-                                    $model->valid_null_style_operators(),
-                                    $model->valid_like_style_operators(),
-                                    $model->valid_between_style_operators()
-                                )
-                            )
-                        ) {
-                            //it's a valid operator, but none of the exceptions. Treat it normally.
-                            $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
-                                $field,
-                                $query_param_value[1],
-                                $requested_version,
-                                $timezone
-                            );
-                        } else {
-                            //so they provided a valid operator, but wrong number of arguments
-                            if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                                throw new RestException(
-                                    'wrong_number_of_arguments',
-                                    sprintf(
-                                        esc_html__(
-                                            'The operator you provided, "%1$s" had the wrong number of arguments',
-                                            'event_espresso'
-                                        ),
-                                        $op
-                                    ),
-                                    array(
-                                        'status' => 400,
-                                    )
-                                );
-                            }
-                            $translated_value = null;
-                        }
-                    } else {
-                        //so they didn't provide a valid operator
-                        if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                            throw new RestException(
-                                'invalid_operator',
-                                sprintf(
-                                    esc_html__(
-                                        'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
-                                        'event_espresso'
-                                    ),
-                                    $query_param_key,
-                                    $query_param_value
-                                ),
-                                array(
-                                    'status' => 400,
-                                )
-                            );
-                        }
-                        //if we aren't in debug mode, then just try our best to fulfill the user's request
-                        $translated_value = null;
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueFromJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version,
-                        $timezone
-                    );
-                }
-                if (
-                    (isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
-                    ||
-                    $translated_value === null
-                ) {
-                    //they have already provided a non-gmt field, ignore the gmt one. That's what WP core
-                    //currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
-                    //OR we couldn't create a translated value from their input
-                    continue;
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so this param doesn't correspond to a field eh?
-                if ($writing) {
-                    //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(
-                            esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
-                            $query_param_key
-                        )
-                    );
-                } else {
-                    //so it's not for a field, is it a logic query param key?
-                    if (in_array(
-                        $query_param_sans_stars,
-                        $model->logic_query_param_keys()
-                    )) {
-                        $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
-                            $query_param_value,
-                            $model,
-                            $requested_version
-                        );
-                    } elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
-                        //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(
-                                esc_html__(
-                                    'You provided an invalid parameter, with key "%1$s"',
-                                    'event_espresso'
-                                ),
-                                $query_param_sans_stars
-                            ),
-                            array(
-                                'status' => 400,
-                            )
-                        );
-                    }
-                }
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * Mostly checks if the last 4 characters are "_gmt", indicating its a
-     * gmt date field name
-     *
-     * @param string $field_name
-     * @return boolean
-     */
-    public static function isGmtDateFieldName($field_name)
-    {
-        return substr(
-            ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
-            -4,
-            4
-        ) === '_gmt';
-    }
-
-
-
-    /**
-     * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function removeGmtFromFieldName($field_name)
-    {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return $field_name;
-        }
-        $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
-            $field_name
-        );
-        $query_param_sans_gmt_and_sans_stars = substr(
-            $query_param_sans_stars,
-            0,
-            strrpos(
-                $field_name,
-                '_gmt'
-            )
-        );
-        return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
-    }
-
-
-
-    /**
-     * Takes a field name from the REST API and prepares it for the model querying
-     *
-     * @param string $field_name
-     * @return string
-     */
-    public static function prepareFieldNameFromJson($field_name)
-    {
-        if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
-            return ModelDataTranslator::removeGmtFromFieldName($field_name);
-        }
-        return $field_name;
-    }
-
-
-
-    /**
-     * Takes array of field names from REST API and prepares for models
-     *
-     * @param array $field_names
-     * @return array of field names (possibly include model prefixes)
-     */
-    public static function prepareFieldNamesFromJson(array $field_names)
-    {
-        $new_array = array();
-        foreach ($field_names as $key => $field_name) {
-            $new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Takes array where array keys are field names (possibly with model path prefixes)
-     * from the REST API and prepares them for model querying
-     *
-     * @param array $field_names_as_keys
-     * @return array
-     */
-    public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
-    {
-        $new_array = array();
-        foreach ($field_names_as_keys as $field_name => $value) {
-            $new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
-        }
-        return $new_array;
-    }
-
-
-
-    /**
-     * Prepares an array of model query params for use in the REST API
-     *
-     * @param array     $model_query_params
-     * @param EEM_Base $model
-     * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
-     *                                     REST API
-     * @return array which can be passed into the EE4 REST API when querying a model resource
-     * @throws EE_Error
-     */
-    public static function prepareQueryParamsForRestApi(
-        array $model_query_params,
-        EEM_Base $model,
-        $requested_version = null
-    ) {
-        if ($requested_version === null) {
-            $requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
-        }
-        $rest_query_params = $model_query_params;
-        if (isset($model_query_params[0])) {
-            $rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params[0],
-                $model,
-                $requested_version
-            );
-            unset($rest_query_params[0]);
-        }
-        if (isset($model_query_params['having'])) {
-            $rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                $model_query_params['having'],
-                $model,
-                $requested_version
-            );
-        }
-        return apply_filters(
-            'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
-            $rest_query_params,
-            $model_query_params,
-            $model,
-            $requested_version
-        );
-    }
-
-
-
-    /**
-     * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
-     *
-     * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
-     *                                                      passed into EEM_Base::get_all()
-     * @param EEM_Base $model
-     * @param string    $requested_version                  eg "4.8.36"
-     * @return array ready for use in the rest api query params
-     * @throws EE_Error
-     * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
-     *                                     (which would be really unusual)
-     */
-    public static function prepareConditionsQueryParamsForRestApi(
-        $inputted_query_params_of_this_type,
-        EEM_Base $model,
-        $requested_version
-    ) {
-        $query_param_for_models = array();
-        foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
-            $field = ModelDataTranslator::deduceFieldFromQueryParam(
-                ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
-                $model
-            );
-            if ($field instanceof EE_Model_Field_Base) {
-                //did they specify an operator?
-                if (is_array($query_param_value)) {
-                    $op = $query_param_value[0];
-                    $translated_value = array($op);
-                    if (isset($query_param_value[1])) {
-                        $value = $query_param_value[1];
-                        $translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
-                            $field,
-                            $value,
-                            $requested_version
-                        );
-                    }
-                } else {
-                    $translated_value = ModelDataTranslator::prepareFieldValueForJson(
-                        $field,
-                        $query_param_value,
-                        $requested_version
-                    );
-                }
-                $query_param_for_models[$query_param_key] = $translated_value;
-            } else {
-                //so it's not for a field, assume it's a logic query param key
-                $query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
-                    $query_param_value,
-                    $model,
-                    $requested_version
-                );
-            }
-        }
-        return $query_param_for_models;
-    }
-
-
-
-    /**
-     * @param $condition_query_param_key
-     * @return string
-     */
-    public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
-    {
-        $pos_of_star = strpos($condition_query_param_key, '*');
-        if ($pos_of_star === false) {
-            return $condition_query_param_key;
-        } else {
-            $condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
-            return $condition_query_param_sans_star;
-        }
-    }
-
-
-
-    /**
-     * Takes the input parameter and finds the model field that it indicates.
-     *
-     * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
-     * @param EEM_Base $model
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     */
-    public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
-    {
-        //ok, now proceed with deducing which part is the model's name, and which is the field's name
-        //which will help us find the database table and column
-        $query_param_parts = explode('.', $query_param_name);
-        if (empty($query_param_parts)) {
-            throw new EE_Error(
-                sprintf(
-                    __(
-                        '_extract_column_name is empty when trying to extract column and table name from %s',
-                        'event_espresso'
-                    ),
-                    $query_param_name
-                )
-            );
-        }
-        $number_of_parts = count($query_param_parts);
-        $last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
-        if ($number_of_parts === 1) {
-            $field_name = $last_query_param_part;
-        } else {// $number_of_parts >= 2
-            //the last part is the column name, and there are only 2parts. therefore...
-            $field_name = $last_query_param_part;
-            $model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
-        }
-        try {
-            return $model->field_settings_for($field_name, false);
-        } catch (EE_Error $e) {
-            return null;
-        }
-    }
-
-
-
-    /**
-     * Returns true if $data can be easily represented in JSON.
-     * Basically, objects and resources can't be represented in JSON easily.
-     * @param mixed $data
-     * @return bool
-     */
-    protected static function isRepresentableInJson($data)
-    {
-        return is_scalar($data)
-               || is_array($data)
-               || is_null($data);
-    }
+	/**
+	 * We used to use -1 for infinity in the rest api, but that's ambiguous for
+	 * fields that COULD contain -1; so we use null
+	 */
+	const EE_INF_IN_REST = null;
+
+
+
+	/**
+	 * Prepares a possible array of input values from JSON for use by the models
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $requested_version
+	 * @param string               $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 */
+	public static function prepareFieldValuesFromJson(
+		$field_obj,
+		$original_value_maybe_array,
+		$requested_version,
+		$timezone_string = 'UTC'
+	) {
+		if (is_array($original_value_maybe_array)
+			&& ! $field_obj instanceof EE_Serialized_Text_Field
+		) {
+			$new_value_maybe_array = array();
+			foreach ($original_value_maybe_array as $array_key => $array_item) {
+				$new_value_maybe_array[$array_key] = ModelDataTranslator::prepareFieldValueFromJson(
+					$field_obj,
+					$array_item,
+					$requested_version,
+					$timezone_string
+				);
+			}
+		} else {
+			$new_value_maybe_array = ModelDataTranslator::prepareFieldValueFromJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$requested_version,
+				$timezone_string
+			);
+		}
+		return $new_value_maybe_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of field values FOR use in JSON/REST API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value_maybe_array
+	 * @param string               $request_version (eg 4.8.36)
+	 * @return array
+	 */
+	public static function prepareFieldValuesForJson($field_obj, $original_value_maybe_array, $request_version)
+	{
+		if (is_array($original_value_maybe_array)) {
+			$new_value = array();
+			foreach ($original_value_maybe_array as $key => $value) {
+				$new_value[$key] = ModelDataTranslator::prepareFieldValuesForJson($field_obj, $value, $request_version);
+			}
+		} else {
+			$new_value = ModelDataTranslator::prepareFieldValueForJson(
+				$field_obj,
+				$original_value_maybe_array,
+				$request_version
+			);
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * Prepares incoming data from the json or $_REQUEST parameters for the models'
+	 * "$query_params".
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed               $original_value
+	 * @param string              $requested_version
+	 * @param string              $timezone_string treat values as being in this timezone
+	 * @return mixed
+	 * @throws RestException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public static function prepareFieldValueFromJson(
+		$field_obj,
+		$original_value,
+		$requested_version,
+		$timezone_string = 'UTC' // UTC
+	) {
+		//check if they accidentally submitted an error value. If so throw an exception
+		if (is_array($original_value)
+			&& isset($original_value['error_code'], $original_value['error_message'])) {
+			throw new RestException(
+				'rest_submitted_error_value',
+				sprintf(
+					esc_html__(
+						'You tried to submit a JSON error object as a value for %1$s. That\'s not allowed.',
+						'event_espresso'
+					),
+					$field_obj->get_name()
+				),
+				array(
+					'status' => 400,
+				)
+			);
+		}
+		//double-check for serialized PHP. We never accept serialized PHP. No way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		$timezone_string = $timezone_string !== '' ? $timezone_string : get_option('timezone_string', '');
+		$new_value = null;
+		//walk through the submitted data and double-check for serialized PHP. We never accept serialized PHP. No
+		// way Jose.
+		ModelDataTranslator::throwExceptionIfContainsSerializedData($original_value);
+		if ($field_obj instanceof EE_Infinite_Integer_Field
+			&& in_array($original_value, array(null, ''), true)
+		) {
+			$new_value = EE_INF;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			$new_value = rest_parse_date(
+				self::getTimestampWithTimezoneOffset($original_value, $field_obj, $timezone_string)
+			);
+			if ($new_value === false) {
+				throw new RestException(
+					'invalid_format_for_timestamp',
+					sprintf(
+						esc_html__(
+							'Timestamps received on a request as the value for Date and Time fields must be in %1$s/%2$s format.  The timestamp provided (%3$s) is not that format.',
+							'event_espresso'
+						),
+						'RFC3339',
+						'ISO8601',
+						$original_value
+					),
+					array(
+						'status' => 400
+					)
+				);
+			}
+		} else {
+			$new_value = $original_value;
+		}
+		return $new_value;
+	}
+
+
+	/**
+	 * This checks if the incoming timestamp has timezone information already on it and if it doesn't then adds timezone
+	 * information via details obtained from the host site.
+	 *
+	 * @param string            $original_timestamp
+	 * @param EE_Datetime_Field $datetime_field
+	 * @param                   $timezone_string
+	 * @return string
+	 * @throws DomainException
+	 */
+	private static function getTimestampWithTimezoneOffset(
+		$original_timestamp,
+		EE_Datetime_Field $datetime_field,
+		$timezone_string
+	) {
+		//already have timezone information?
+		if (preg_match('/Z|(\+|\-)(\d{2}:\d{2})/', $original_timestamp)) {
+			//yes, we're ignoring the timezone.
+			return $original_timestamp;
+		}
+		//need to append timezone
+		list($offset_sign, $offset_secs) = self::parseTimezoneOffset(
+			$datetime_field->get_timezone_offset(
+				new \DateTimeZone($timezone_string),
+				$original_timestamp
+			)
+		);
+		$offset_string =
+			str_pad(
+				floor($offset_secs / HOUR_IN_SECONDS),
+				2,
+				'0',
+				STR_PAD_LEFT
+			)
+			. ':'
+			. str_pad(
+				($offset_secs % HOUR_IN_SECONDS) / MINUTE_IN_SECONDS,
+				2,
+				'0',
+				STR_PAD_LEFT
+			);
+		return $original_timestamp . $offset_sign . $offset_string;
+	}
+
+
+
+	/**
+	 * Throws an exception if $data is a serialized PHP string (or somehow an actually PHP object, although I don't
+	 * think that can happen). If $data is an array, recurses into its keys and values
+	 * @param mixed $data
+	 * @throws RestException
+	 * @return void
+	 */
+	public static function throwExceptionIfContainsSerializedData($data)
+	{
+		if (is_array($data)) {
+			foreach ($data as $key => $value) {
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($key);
+				ModelDataTranslator::throwExceptionIfContainsSerializedData($value);
+			}
+		} else {
+			if (is_serialized($data) || is_object($data)) {
+				throw new RestException(
+					'serialized_data_submission_prohibited',
+					esc_html__(
+						// @codingStandardsIgnoreStart
+						'You tried to submit a string of serialized text. Serialized PHP is prohibited over the EE4 REST API.',
+						// @codingStandardsIgnoreEnd
+						'event_espresso'
+					)
+				);
+			}
+		}
+	}
+
+
+
+	/**
+	 * determines what's going on with them timezone strings
+	 *
+	 * @param int $timezone_offset
+	 * @return array
+	 */
+	private static function parseTimezoneOffset($timezone_offset)
+	{
+		$first_char = substr((string)$timezone_offset, 0, 1);
+		if ($first_char === '+' || $first_char === '-') {
+			$offset_sign = $first_char;
+			$offset_secs = substr((string)$timezone_offset, 1);
+		} else {
+			$offset_sign = '+';
+			$offset_secs = $timezone_offset;
+		}
+		return array($offset_sign, $offset_secs);
+	}
+
+
+
+	/**
+	 * Prepares a field's value for display in the API
+	 *
+	 * @param EE_Model_Field_Base $field_obj
+	 * @param mixed                $original_value
+	 * @param string               $requested_version
+	 * @return mixed
+	 */
+	public static function prepareFieldValueForJson($field_obj, $original_value, $requested_version)
+	{
+		if ($original_value === EE_INF) {
+			$new_value = ModelDataTranslator::EE_INF_IN_REST;
+		} elseif ($field_obj instanceof EE_Datetime_Field) {
+			if (is_string($original_value)) {
+				//did they submit a string of a unix timestamp?
+				if (is_numeric($original_value)) {
+					$datetime_obj = new \DateTime();
+					$datetime_obj->setTimestamp((int)$original_value);
+				} else {
+					//first, check if its a MySQL timestamp in GMT
+					$datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
+				}
+				if (! $datetime_obj instanceof \DateTime) {
+					//so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
+					$datetime_obj = $field_obj->prepare_for_set($original_value);
+				}
+				$original_value = $datetime_obj;
+			}
+			if ($original_value instanceof \DateTime) {
+				$new_value = $original_value->format('Y-m-d H:i:s');
+			} elseif (is_int($original_value) || is_float($original_value)) {
+				$new_value = date('Y-m-d H:i:s', $original_value);
+			} elseif($original_value === null || $original_value === '') {
+				$new_value = null;
+			} else {
+				//so it's not a datetime object, unix timestamp (as string or int),
+				//MySQL timestamp, or even a string in the field object's format. So no idea what it is
+				throw new \EE_Error(
+					sprintf(
+						esc_html__(
+						// @codingStandardsIgnoreStart
+							'The value "%1$s" for the field "%2$s" on model "%3$s" could not be understood. It should be a PHP DateTime, unix timestamp, MySQL date, or string in the format "%4$s".',
+							// @codingStandardsIgnoreEnd
+							'event_espressso'
+						),
+						$original_value,
+						$field_obj->get_name(),
+						$field_obj->get_model_name(),
+						$field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+					)
+				);
+			}
+			$new_value = mysql_to_rfc3339($new_value);
+		} else {
+			$new_value = $original_value;
+		}
+		//are we about to send an object? just don't. We have no good way to represent it in JSON.
+		// can't just check using is_object() because that missed PHP incomplete objects
+		if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+			$new_value = array(
+				'error_code' => 'php_object_not_return',
+				'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_field_for_rest_api',
+			$new_value,
+			$field_obj,
+			$original_value,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares condition-query-parameters (like what's in where and having) from
+	 * the format expected in the API to use in the models
+	 *
+	 * @param array     $inputted_query_params_of_this_type
+	 * @param EEM_Base $model
+	 * @param string    $requested_version
+	 * @param boolean $writing whether this data will be written to the DB, or if we're just building a query.
+	 *                         If we're writing to the DB, we don't expect any operators, or any logic query parameters,
+	 *                         and we also won't accept serialized data unless the current user has unfiltered_html.
+	 * @return array
+	 * @throws DomainException
+	 * @throws RestException
+	 * @throws EE_Error
+	 */
+	public static function prepareConditionsQueryParamsForModels(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version,
+		$writing = false
+	) {
+		$query_param_for_models = array();
+		$valid_operators = $model->valid_operators();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$is_gmt_datetime_field = false;
+			$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+				$query_param_key
+			);
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				$query_param_sans_stars,
+				$model
+			);
+			//double-check is it a *_gmt field?
+			if (! $field instanceof EE_Model_Field_Base
+				&& ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
+			) {
+				//yep, take off '_gmt', and find the field
+				$query_param_key = ModelDataTranslator::removeGmtFromFieldName($query_param_sans_stars);
+				$field = ModelDataTranslator::deduceFieldFromQueryParam(
+					$query_param_key,
+					$model
+				);
+				$timezone = 'UTC';
+				$is_gmt_datetime_field = true;
+			} elseif ($field instanceof EE_Datetime_Field) {
+				//so it's not a GMT field. Set the timezone on the model to the default
+				$timezone = \EEH_DTT_Helper::get_valid_timezone_string();
+			} else {
+				//just keep using what's already set for the timezone
+				$timezone = $model->get_timezone();
+			}
+			if ($field instanceof EE_Model_Field_Base) {
+				if (! $writing && is_array($query_param_value)) {
+					if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'numerically_indexed_array_of_values_only',
+								sprintf(
+									esc_html__(
+										'The array provided for the parameter "%1$s" should be numerically indexed.',
+										'event_espresso'
+									),
+									$query_param_key
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+					}
+					//did they specify an operator?
+					if (isset($query_param_value[0])
+						&& isset($valid_operators[$query_param_value[0]])
+					) {
+						$op = $query_param_value[0];
+						$translated_value = array($op);
+						if (array_key_exists($op, $model->valid_in_style_operators())
+							&& isset($query_param_value[1])
+							&& ! isset($query_param_value[2])
+						) {
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} elseif (array_key_exists($op, $model->valid_between_style_operators())
+							&& isset($query_param_value[1], $query_param_value[2])
+							&& !isset($query_param_value[3])
+						) {
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[2],
+								$requested_version,
+								$timezone
+							);
+						} elseif (array_key_exists($op, $model->valid_like_style_operators())
+							&& isset($query_param_value[1])
+							&& ! isset($query_param_value[2])
+						) {
+							//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 (array_key_exists($op, $model->valid_null_style_operators())
+							&& !isset($query_param_value[1])) {
+							//no arguments should have been provided, so don't look for any
+						} elseif (isset($query_param_value[1])
+							&& !isset($query_param_value[2])
+							&& ! array_key_exists(
+								$op,
+								array_merge(
+									$model->valid_in_style_operators(),
+									$model->valid_null_style_operators(),
+									$model->valid_like_style_operators(),
+									$model->valid_between_style_operators()
+								)
+							)
+						) {
+							//it's a valid operator, but none of the exceptions. Treat it normally.
+							$translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
+								$field,
+								$query_param_value[1],
+								$requested_version,
+								$timezone
+							);
+						} else {
+							//so they provided a valid operator, but wrong number of arguments
+							if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+								throw new RestException(
+									'wrong_number_of_arguments',
+									sprintf(
+										esc_html__(
+											'The operator you provided, "%1$s" had the wrong number of arguments',
+											'event_espresso'
+										),
+										$op
+									),
+									array(
+										'status' => 400,
+									)
+								);
+							}
+							$translated_value = null;
+						}
+					} else {
+						//so they didn't provide a valid operator
+						if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+							throw new RestException(
+								'invalid_operator',
+								sprintf(
+									esc_html__(
+										'You provided an invalid parameter, with key "%1$s" and value "%2$s"',
+										'event_espresso'
+									),
+									$query_param_key,
+									$query_param_value
+								),
+								array(
+									'status' => 400,
+								)
+							);
+						}
+						//if we aren't in debug mode, then just try our best to fulfill the user's request
+						$translated_value = null;
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueFromJson(
+						$field,
+						$query_param_value,
+						$requested_version,
+						$timezone
+					);
+				}
+				if (
+					(isset($query_param_for_models[$query_param_key]) && $is_gmt_datetime_field)
+					||
+					$translated_value === null
+				) {
+					//they have already provided a non-gmt field, ignore the gmt one. That's what WP core
+					//currently does (they might change it though). See https://core.trac.wordpress.org/ticket/39954
+					//OR we couldn't create a translated value from their input
+					continue;
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so this param doesn't correspond to a field eh?
+				if ($writing) {
+					//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(
+							esc_html__('You have provided an invalid parameter: "%1$s"', 'event_espresso'),
+							$query_param_key
+						)
+					);
+				} else {
+					//so it's not for a field, is it a logic query param key?
+					if (in_array(
+						$query_param_sans_stars,
+						$model->logic_query_param_keys()
+					)) {
+						$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForModels(
+							$query_param_value,
+							$model,
+							$requested_version
+						);
+					} elseif (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
+						//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(
+								esc_html__(
+									'You provided an invalid parameter, with key "%1$s"',
+									'event_espresso'
+								),
+								$query_param_sans_stars
+							),
+							array(
+								'status' => 400,
+							)
+						);
+					}
+				}
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * Mostly checks if the last 4 characters are "_gmt", indicating its a
+	 * gmt date field name
+	 *
+	 * @param string $field_name
+	 * @return boolean
+	 */
+	public static function isGmtDateFieldName($field_name)
+	{
+		return substr(
+			ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($field_name),
+			-4,
+			4
+		) === '_gmt';
+	}
+
+
+
+	/**
+	 * Removes the last "_gmt" part of a field name (and if there is no "_gmt" at the end, leave it alone)
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function removeGmtFromFieldName($field_name)
+	{
+		if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return $field_name;
+		}
+		$query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(
+			$field_name
+		);
+		$query_param_sans_gmt_and_sans_stars = substr(
+			$query_param_sans_stars,
+			0,
+			strrpos(
+				$field_name,
+				'_gmt'
+			)
+		);
+		return str_replace($query_param_sans_stars, $query_param_sans_gmt_and_sans_stars, $field_name);
+	}
+
+
+
+	/**
+	 * Takes a field name from the REST API and prepares it for the model querying
+	 *
+	 * @param string $field_name
+	 * @return string
+	 */
+	public static function prepareFieldNameFromJson($field_name)
+	{
+		if (ModelDataTranslator::isGmtDateFieldName($field_name)) {
+			return ModelDataTranslator::removeGmtFromFieldName($field_name);
+		}
+		return $field_name;
+	}
+
+
+
+	/**
+	 * Takes array of field names from REST API and prepares for models
+	 *
+	 * @param array $field_names
+	 * @return array of field names (possibly include model prefixes)
+	 */
+	public static function prepareFieldNamesFromJson(array $field_names)
+	{
+		$new_array = array();
+		foreach ($field_names as $key => $field_name) {
+			$new_array[$key] = ModelDataTranslator::prepareFieldNameFromJson($field_name);
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Takes array where array keys are field names (possibly with model path prefixes)
+	 * from the REST API and prepares them for model querying
+	 *
+	 * @param array $field_names_as_keys
+	 * @return array
+	 */
+	public static function prepareFieldNamesInArrayKeysFromJson(array $field_names_as_keys)
+	{
+		$new_array = array();
+		foreach ($field_names_as_keys as $field_name => $value) {
+			$new_array[ModelDataTranslator::prepareFieldNameFromJson($field_name)] = $value;
+		}
+		return $new_array;
+	}
+
+
+
+	/**
+	 * Prepares an array of model query params for use in the REST API
+	 *
+	 * @param array     $model_query_params
+	 * @param EEM_Base $model
+	 * @param string    $requested_version eg "4.8.36". If null is provided, defaults to the latest release of the EE4
+	 *                                     REST API
+	 * @return array which can be passed into the EE4 REST API when querying a model resource
+	 * @throws EE_Error
+	 */
+	public static function prepareQueryParamsForRestApi(
+		array $model_query_params,
+		EEM_Base $model,
+		$requested_version = null
+	) {
+		if ($requested_version === null) {
+			$requested_version = \EED_Core_Rest_Api::latest_rest_api_version();
+		}
+		$rest_query_params = $model_query_params;
+		if (isset($model_query_params[0])) {
+			$rest_query_params['where'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params[0],
+				$model,
+				$requested_version
+			);
+			unset($rest_query_params[0]);
+		}
+		if (isset($model_query_params['having'])) {
+			$rest_query_params['having'] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+				$model_query_params['having'],
+				$model,
+				$requested_version
+			);
+		}
+		return apply_filters(
+			'FHEE__EventEspresso\core\libraries\rest_api\Model_Data_Translator__prepare_query_params_for_rest_api',
+			$rest_query_params,
+			$model_query_params,
+			$model,
+			$requested_version
+		);
+	}
+
+
+
+	/**
+	 * Prepares all the sub-conditions query parameters (eg having or where conditions) for use in the rest api
+	 *
+	 * @param array     $inputted_query_params_of_this_type eg like the "where" or "having" conditions query params
+	 *                                                      passed into EEM_Base::get_all()
+	 * @param EEM_Base $model
+	 * @param string    $requested_version                  eg "4.8.36"
+	 * @return array ready for use in the rest api query params
+	 * @throws EE_Error
+	 * @throws ObjectDetectedException if somehow a PHP object were in the query params' values,
+	 *                                     (which would be really unusual)
+	 */
+	public static function prepareConditionsQueryParamsForRestApi(
+		$inputted_query_params_of_this_type,
+		EEM_Base $model,
+		$requested_version
+	) {
+		$query_param_for_models = array();
+		foreach ($inputted_query_params_of_this_type as $query_param_key => $query_param_value) {
+			$field = ModelDataTranslator::deduceFieldFromQueryParam(
+				ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey($query_param_key),
+				$model
+			);
+			if ($field instanceof EE_Model_Field_Base) {
+				//did they specify an operator?
+				if (is_array($query_param_value)) {
+					$op = $query_param_value[0];
+					$translated_value = array($op);
+					if (isset($query_param_value[1])) {
+						$value = $query_param_value[1];
+						$translated_value[1] = ModelDataTranslator::prepareFieldValuesForJson(
+							$field,
+							$value,
+							$requested_version
+						);
+					}
+				} else {
+					$translated_value = ModelDataTranslator::prepareFieldValueForJson(
+						$field,
+						$query_param_value,
+						$requested_version
+					);
+				}
+				$query_param_for_models[$query_param_key] = $translated_value;
+			} else {
+				//so it's not for a field, assume it's a logic query param key
+				$query_param_for_models[$query_param_key] = ModelDataTranslator::prepareConditionsQueryParamsForRestApi(
+					$query_param_value,
+					$model,
+					$requested_version
+				);
+			}
+		}
+		return $query_param_for_models;
+	}
+
+
+
+	/**
+	 * @param $condition_query_param_key
+	 * @return string
+	 */
+	public static function removeStarsAndAnythingAfterFromConditionQueryParamKey($condition_query_param_key)
+	{
+		$pos_of_star = strpos($condition_query_param_key, '*');
+		if ($pos_of_star === false) {
+			return $condition_query_param_key;
+		} else {
+			$condition_query_param_sans_star = substr($condition_query_param_key, 0, $pos_of_star);
+			return $condition_query_param_sans_star;
+		}
+	}
+
+
+
+	/**
+	 * Takes the input parameter and finds the model field that it indicates.
+	 *
+	 * @param string    $query_param_name like Registration.Transaction.TXN_ID, Event.Datetime.start_time, or REG_ID
+	 * @param EEM_Base $model
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 */
+	public static function deduceFieldFromQueryParam($query_param_name, EEM_Base $model)
+	{
+		//ok, now proceed with deducing which part is the model's name, and which is the field's name
+		//which will help us find the database table and column
+		$query_param_parts = explode('.', $query_param_name);
+		if (empty($query_param_parts)) {
+			throw new EE_Error(
+				sprintf(
+					__(
+						'_extract_column_name is empty when trying to extract column and table name from %s',
+						'event_espresso'
+					),
+					$query_param_name
+				)
+			);
+		}
+		$number_of_parts = count($query_param_parts);
+		$last_query_param_part = $query_param_parts[count($query_param_parts) - 1];
+		if ($number_of_parts === 1) {
+			$field_name = $last_query_param_part;
+		} else {// $number_of_parts >= 2
+			//the last part is the column name, and there are only 2parts. therefore...
+			$field_name = $last_query_param_part;
+			$model = \EE_Registry::instance()->load_model($query_param_parts[$number_of_parts - 2]);
+		}
+		try {
+			return $model->field_settings_for($field_name, false);
+		} catch (EE_Error $e) {
+			return null;
+		}
+	}
+
+
+
+	/**
+	 * Returns true if $data can be easily represented in JSON.
+	 * Basically, objects and resources can't be represented in JSON easily.
+	 * @param mixed $data
+	 * @return bool
+	 */
+	protected static function isRepresentableInJson($data)
+	{
+		return is_scalar($data)
+			   || is_array($data)
+			   || is_null($data);
+	}
 }

Spacing +16 added lines, -16 removed lines

@@ -11,7 +11,7 @@ 
 use EE_Serialized_Text_Field;
 use EEM_Base;
 
-if (! defined('EVENT_ESPRESSO_VERSION')) {
+if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -228,7 +228,7 @@ 
                 '0',
                 STR_PAD_LEFT
             );
-        return $original_timestamp . $offset_sign . $offset_string;
+        return $original_timestamp.$offset_sign.$offset_string;
     }
 
 
@@ -272,10 +272,10 @@ 
      */
     private static function parseTimezoneOffset($timezone_offset)
     {
-        $first_char = substr((string)$timezone_offset, 0, 1);
+        $first_char = substr((string) $timezone_offset, 0, 1);
         if ($first_char === '+' || $first_char === '-') {
             $offset_sign = $first_char;
-            $offset_secs = substr((string)$timezone_offset, 1);
+            $offset_secs = substr((string) $timezone_offset, 1);
         } else {
             $offset_sign = '+';
             $offset_secs = $timezone_offset;
@@ -302,12 +302,12 @@ 
                 //did they submit a string of a unix timestamp?
                 if (is_numeric($original_value)) {
                     $datetime_obj = new \DateTime();
-                    $datetime_obj->setTimestamp((int)$original_value);
+                    $datetime_obj->setTimestamp((int) $original_value);
                 } else {
                     //first, check if its a MySQL timestamp in GMT
                     $datetime_obj = \DateTime::createFromFormat('Y-m-d H:i:s', $original_value);
                 }
-                if (! $datetime_obj instanceof \DateTime) {
+                if ( ! $datetime_obj instanceof \DateTime) {
                     //so it's not a unix timestamp or a MySQL timestamp. Maybe its in the field's date/time format?
                     $datetime_obj = $field_obj->prepare_for_set($original_value);
                 }
@@ -317,7 +317,7 @@ 
                 $new_value = $original_value->format('Y-m-d H:i:s');
             } elseif (is_int($original_value) || is_float($original_value)) {
                 $new_value = date('Y-m-d H:i:s', $original_value);
-            } elseif($original_value === null || $original_value === '') {
+            } elseif ($original_value === null || $original_value === '') {
                 $new_value = null;
             } else {
                 //so it's not a datetime object, unix timestamp (as string or int),
@@ -333,7 +333,7 @@ 
                         $original_value,
                         $field_obj->get_name(),
                         $field_obj->get_model_name(),
-                        $field_obj->get_time_format() . ' ' . $field_obj->get_time_format()
+                        $field_obj->get_time_format().' '.$field_obj->get_time_format()
                     )
                 );
             }
@@ -343,7 +343,7 @@ 
         }
         //are we about to send an object? just don't. We have no good way to represent it in JSON.
         // can't just check using is_object() because that missed PHP incomplete objects
-        if (! ModelDataTranslator::isRepresentableInJson($new_value)) {
+        if ( ! ModelDataTranslator::isRepresentableInJson($new_value)) {
             $new_value = array(
                 'error_code' => 'php_object_not_return',
                 'error_message' => esc_html__('The value of this field in the database is a PHP object, which can\'t be represented in JSON.', 'event_espresso')
@@ -393,7 +393,7 @@ 
                 $model
             );
             //double-check is it a *_gmt field?
-            if (! $field instanceof EE_Model_Field_Base
+            if ( ! $field instanceof EE_Model_Field_Base
                 && ModelDataTranslator::isGmtDateFieldName($query_param_sans_stars)
             ) {
                 //yep, take off '_gmt', and find the field
@@ -412,8 +412,8 @@ 
                 $timezone = $model->get_timezone();
             }
             if ($field instanceof EE_Model_Field_Base) {
-                if (! $writing && is_array($query_param_value)) {
-                    if (! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
+                if ( ! $writing && is_array($query_param_value)) {
+                    if ( ! \EEH_Array::is_array_numerically_and_sequentially_indexed($query_param_value)) {
                         if (defined('EE_REST_API_DEBUG_MODE') && EE_REST_API_DEBUG_MODE) {
                             throw new RestException(
                                 'numerically_indexed_array_of_values_only',
@@ -448,7 +448,7 @@ 
                             );
                         } elseif (array_key_exists($op, $model->valid_between_style_operators())
                             && isset($query_param_value[1], $query_param_value[2])
-                            && !isset($query_param_value[3])
+                            && ! isset($query_param_value[3])
                         ) {
                             $translated_value[] = ModelDataTranslator::prepareFieldValuesFromJson(
                                 $field,
@@ -472,10 +472,10 @@ 
                             ModelDataTranslator::throwExceptionIfContainsSerializedData($query_param_value[1]);
                             $translated_value[] = $query_param_value[1];
                         } elseif (array_key_exists($op, $model->valid_null_style_operators())
-                            && !isset($query_param_value[1])) {
+                            && ! isset($query_param_value[1])) {
                             //no arguments should have been provided, so don't look for any
                         } elseif (isset($query_param_value[1])
-                            && !isset($query_param_value[2])
+                            && ! isset($query_param_value[2])
                             && ! array_key_exists(
                                 $op,
                                 array_merge(
@@ -626,7 +626,7 @@ 
      */
     public static function removeGmtFromFieldName($field_name)
     {
-        if (! ModelDataTranslator::isGmtDateFieldName($field_name)) {
+        if ( ! ModelDataTranslator::isGmtDateFieldName($field_name)) {
             return $field_name;
         }
         $query_param_sans_stars = ModelDataTranslator::removeStarsAndAnythingAfterFromConditionQueryParamKey(

core/admin/EE_Admin_Page_CPT.core.php

Indentation +1432 added lines, -1432 removed lines

@@ -1,5 +1,5 @@ 
 <?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 /**
@@ -24,470 +24,470 @@ 
 {
 
 
-    /**
-     * This gets set in _setup_cpt
-     * It will contain the object for the custom post type.
-     *
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_object;
-
-
-
-    /**
-     * a boolean flag to set whether the current route is a cpt route or not.
-     *
-     * @var bool
-     */
-    protected $_cpt_route = false;
-
-
-
-    /**
-     * This property allows cpt classes to define multiple routes as cpt routes.
-     * //in this array we define what the custom post type for this route is.
-     * array(
-     * 'route_name' => 'custom_post_type_slug'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_routes = array();
-
+	/**
+	 * This gets set in _setup_cpt
+	 * It will contain the object for the custom post type.
+	 *
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_object;
+
+
+
+	/**
+	 * a boolean flag to set whether the current route is a cpt route or not.
+	 *
+	 * @var bool
+	 */
+	protected $_cpt_route = false;
+
+
+
+	/**
+	 * This property allows cpt classes to define multiple routes as cpt routes.
+	 * //in this array we define what the custom post type for this route is.
+	 * array(
+	 * 'route_name' => 'custom_post_type_slug'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_routes = array();
+
 
 
-    /**
-     * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
-     * in this format:
-     * array(
-     * 'post_type_slug' => 'edit_route'
-     * )
-     *
-     * @var array
-     */
-    protected $_cpt_edit_routes = array();
-
-
-
-    /**
-     * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
-     * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
-     * _cpt_model_names property should be in the following format: array(
-     * 'route_defined_by_action_param' => 'Model_Name')
-     *
-     * @var array $_cpt_model_names
-     */
-    protected $_cpt_model_names = array();
-
-
-    /**
-     * @var EE_CPT_Base
-     */
-    protected $_cpt_model_obj = false;
-
-
-
-    /**
-     * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
-     * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
-     * the _register_autosave_containers() method so that we don't override any other containers already registered.
-     * Registration of containers should be done before load_page_dependencies() is run.
-     *
-     * @var array()
-     */
-    protected $_autosave_containers = array();
-    protected $_autosave_fields = array();
-
-    /**
-     * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
-     * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
-     *
-     * @var array
-     */
-    protected $_pagenow_map;
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
-     * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
-     * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
-     * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
-     * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
-     *
-     * @access protected
-     * @abstract
-     * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
-     * @param  EE_CPT_Base $post    The post object of the cpt that was saved.
-     * @return void
-     */
-    abstract protected function _insert_update_cpt_item($post_id, $post);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
-     *
-     * @abstract
-     * @access public
-     * @param  string $post_id The ID of the cpt that was trashed
-     * @return void
-     */
-    abstract public function trash_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
-     *
-     * @param  string $post_id theID of the cpt that was untrashed
-     * @return void
-     */
-    abstract public function restore_cpt_item($post_id);
-
-
-
-    /**
-     * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
-     * from the db
-     *
-     * @param  string $post_id the ID of the cpt that was deleted
-     * @return void
-     */
-    abstract public function delete_cpt_item($post_id);
-
-
-
-    /**
-     * Just utilizing the method EE_Admin exposes for doing things before page setup.
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _before_page_setup()
-    {
-        $page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
-        $this->_cpt_routes = array_merge(array(
-            'create_new' => $this->page_slug,
-            'edit'       => $this->page_slug,
-            'trash'      => $this->page_slug,
-        ), $this->_cpt_routes);
-        //let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
-        $this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
-            ? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
-            : get_post_type_object($page);
-        //tweak pagenow for page loading.
-        if ( ! $this->_pagenow_map) {
-            $this->_pagenow_map = array(
-                'create_new' => 'post-new.php',
-                'edit'       => 'post.php',
-                'trash'      => 'post.php',
-            );
-        }
-        add_action('current_screen', array($this, 'modify_pagenow'));
-        //TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
-        //get current page from autosave
-        $current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
-            ? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
-            : null;
-        $this->_current_page = isset($this->_req_data['current_page'])
-            ? $this->_req_data['current_page']
-            : $current_page;
-        //autosave... make sure its only for the correct page
-        //if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
-            //setup autosave ajax hook
-            //add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
-        //}
-    }
-
-
-
-    /**
-     * Simply ensure that we simulate the correct post route for cpt screens
-     *
-     * @param WP_Screen $current_screen
-     * @return void
-     */
-    public function modify_pagenow($current_screen)
-    {
-        global $pagenow, $hook_suffix;
-        //possibly reset pagenow.
-        if ( ! empty($this->_req_data['page'])
-             && $this->_req_data['page'] == $this->page_slug
-             && ! empty($this->_req_data['action'])
-             && isset($this->_pagenow_map[$this->_req_data['action']])
-        ) {
-            $pagenow = $this->_pagenow_map[$this->_req_data['action']];
-            $hook_suffix = $pagenow;
-        }
-    }
-
-
-
-    /**
-     * This method is used to register additional autosave containers to the _autosave_containers property.
-     *
-     * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
-     *       automatically register the id for the post metabox as a container.
-     * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
-     *                    you would send along the id of a metabox container.
-     * @return void
-     */
-    protected function _register_autosave_containers($ids)
-    {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
-    }
-
-
-
-    /**
-     * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
-     * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
-     */
-    protected function _set_autosave_containers()
-    {
-        global $wp_meta_boxes;
-        $containers = array();
-        if (empty($wp_meta_boxes)) {
-            return;
-        }
-        $current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
-        foreach ($current_metaboxes as $box_context) {
-            foreach ($box_context as $box_details) {
-                foreach ($box_details as $box) {
-                    if (
-                        is_array($box['callback'])
-                        && (
-                            $box['callback'][0] instanceof EE_Admin_Page
-                            || $box['callback'][0] instanceof EE_Admin_Hooks
-                        )
-                    ) {
-                        $containers[] = $box['id'];
-                    }
-                }
-            }
-        }
-        $this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
-        //add hidden inputs container
-        $this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
-    }
-
-
-
-    protected function _load_autosave_scripts_styles()
-    {
-        /*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
+	/**
+	 * This simply defines what the corresponding routes WP will be redirected to after completing a post save/update.
+	 * in this format:
+	 * array(
+	 * 'post_type_slug' => 'edit_route'
+	 * )
+	 *
+	 * @var array
+	 */
+	protected $_cpt_edit_routes = array();
+
+
+
+	/**
+	 * If child classes set the name of their main model via the $_cpt_obj_models property, EE_Admin_Page_CPT will
+	 * attempt to retrieve the related object model for the edit pages and assign it to _cpt_page_object. the
+	 * _cpt_model_names property should be in the following format: array(
+	 * 'route_defined_by_action_param' => 'Model_Name')
+	 *
+	 * @var array $_cpt_model_names
+	 */
+	protected $_cpt_model_names = array();
+
+
+	/**
+	 * @var EE_CPT_Base
+	 */
+	protected $_cpt_model_obj = false;
+
+
+
+	/**
+	 * This will hold an array of autosave containers that will be used to obtain input values and hook into the WP
+	 * autosave so we can save our inputs on the save_post hook!  Children classes should add to this array by using
+	 * the _register_autosave_containers() method so that we don't override any other containers already registered.
+	 * Registration of containers should be done before load_page_dependencies() is run.
+	 *
+	 * @var array()
+	 */
+	protected $_autosave_containers = array();
+	protected $_autosave_fields = array();
+
+	/**
+	 * Array mapping from admin actions to their equivalent wp core pages for custom post types. So when a user visits
+	 * a page for an action, it will appear as if they were visiting the wp core page for that custom post type
+	 *
+	 * @var array
+	 */
+	protected $_pagenow_map;
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('save_post') hook and runs after the custom post type has been
+	 * saved.  Child classes are required to declare this method.  Typically you would use this to save any additional
+	 * data. Keep in mind also that "save_post" runs on EVERY post update to the database. ALSO very important.  When a
+	 * post transitions from scheduled to published, the save_post action is fired but you will NOT have any _POST data
+	 * containing any extra info you may have from other meta saves.  So MAKE sure that you handle this accordingly.
+	 *
+	 * @access protected
+	 * @abstract
+	 * @param  string $post_id The ID of the cpt that was saved (so you can link relationally)
+	 * @param  EE_CPT_Base $post    The post object of the cpt that was saved.
+	 * @return void
+	 */
+	abstract protected function _insert_update_cpt_item($post_id, $post);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('trashed_post') hook and runs after a cpt has been trashed.
+	 *
+	 * @abstract
+	 * @access public
+	 * @param  string $post_id The ID of the cpt that was trashed
+	 * @return void
+	 */
+	abstract public function trash_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('untrashed_post') hook and runs after a cpt has been untrashed
+	 *
+	 * @param  string $post_id theID of the cpt that was untrashed
+	 * @return void
+	 */
+	abstract public function restore_cpt_item($post_id);
+
+
+
+	/**
+	 * This is hooked into the WordPress do_action('delete_cpt_item') hook and runs after a cpt has been fully deleted
+	 * from the db
+	 *
+	 * @param  string $post_id the ID of the cpt that was deleted
+	 * @return void
+	 */
+	abstract public function delete_cpt_item($post_id);
+
+
+
+	/**
+	 * Just utilizing the method EE_Admin exposes for doing things before page setup.
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _before_page_setup()
+	{
+		$page = isset($this->_req_data['page']) ? $this->_req_data['page'] : $this->page_slug;
+		$this->_cpt_routes = array_merge(array(
+			'create_new' => $this->page_slug,
+			'edit'       => $this->page_slug,
+			'trash'      => $this->page_slug,
+		), $this->_cpt_routes);
+		//let's see if the current route has a value for cpt_object_slug if it does we use that instead of the page
+		$this->_cpt_object = isset($this->_req_data['action']) && isset($this->_cpt_routes[$this->_req_data['action']])
+			? get_post_type_object($this->_cpt_routes[$this->_req_data['action']])
+			: get_post_type_object($page);
+		//tweak pagenow for page loading.
+		if ( ! $this->_pagenow_map) {
+			$this->_pagenow_map = array(
+				'create_new' => 'post-new.php',
+				'edit'       => 'post.php',
+				'trash'      => 'post.php',
+			);
+		}
+		add_action('current_screen', array($this, 'modify_pagenow'));
+		//TODO the below will need to be reworked to account for the cpt routes that are NOT based off of page but action param.
+		//get current page from autosave
+		$current_page = isset($this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page'])
+			? $this->_req_data['ee_autosave_data']['ee-cpt-hidden-inputs']['current_page']
+			: null;
+		$this->_current_page = isset($this->_req_data['current_page'])
+			? $this->_req_data['current_page']
+			: $current_page;
+		//autosave... make sure its only for the correct page
+		//if ( ! empty($this->_current_page) && $this->_current_page == $this->page_slug) {
+			//setup autosave ajax hook
+			//add_action('wp_ajax_ee-autosave', array( $this, 'do_extra_autosave_stuff' ), 10 ); //TODO reactivate when 4.2 autosave is implemented
+		//}
+	}
+
+
+
+	/**
+	 * Simply ensure that we simulate the correct post route for cpt screens
+	 *
+	 * @param WP_Screen $current_screen
+	 * @return void
+	 */
+	public function modify_pagenow($current_screen)
+	{
+		global $pagenow, $hook_suffix;
+		//possibly reset pagenow.
+		if ( ! empty($this->_req_data['page'])
+			 && $this->_req_data['page'] == $this->page_slug
+			 && ! empty($this->_req_data['action'])
+			 && isset($this->_pagenow_map[$this->_req_data['action']])
+		) {
+			$pagenow = $this->_pagenow_map[$this->_req_data['action']];
+			$hook_suffix = $pagenow;
+		}
+	}
+
+
+
+	/**
+	 * This method is used to register additional autosave containers to the _autosave_containers property.
+	 *
+	 * @todo We should automate this at some point by creating a wrapper for add_post_metabox and in our wrapper we
+	 *       automatically register the id for the post metabox as a container.
+	 * @param  array $ids an array of ids for containers that hold form inputs we want autosave to pickup.  Typically
+	 *                    you would send along the id of a metabox container.
+	 * @return void
+	 */
+	protected function _register_autosave_containers($ids)
+	{
+		$this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+	}
+
+
+
+	/**
+	 * Something nifty.  We're going to loop through all the registered metaboxes and if the CALLBACK is an instance of
+	 * EE_Admin_Page OR EE_Admin_Hooks, then we'll add the id to our _autosave_containers array.
+	 */
+	protected function _set_autosave_containers()
+	{
+		global $wp_meta_boxes;
+		$containers = array();
+		if (empty($wp_meta_boxes)) {
+			return;
+		}
+		$current_metaboxes = isset($wp_meta_boxes[$this->page_slug]) ? $wp_meta_boxes[$this->page_slug] : array();
+		foreach ($current_metaboxes as $box_context) {
+			foreach ($box_context as $box_details) {
+				foreach ($box_details as $box) {
+					if (
+						is_array($box['callback'])
+						&& (
+							$box['callback'][0] instanceof EE_Admin_Page
+							|| $box['callback'][0] instanceof EE_Admin_Hooks
+						)
+					) {
+						$containers[] = $box['id'];
+					}
+				}
+			}
+		}
+		$this->_autosave_containers = array_merge($this->_autosave_containers, $containers);
+		//add hidden inputs container
+		$this->_autosave_containers[] = 'ee-cpt-hidden-inputs';
+	}
+
+
+
+	protected function _load_autosave_scripts_styles()
+	{
+		/*wp_register_script('cpt-autosave', EE_ADMIN_URL . 'assets/ee-cpt-autosave.js', array('ee-serialize-full-array', 'event_editor_js'), EVENT_ESPRESSO_VERSION, TRUE );
         wp_enqueue_script('cpt-autosave');/**/ //todo re-enable when we start doing autosave again in 4.2
 
-        //filter _autosave_containers
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
-            $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
-            $containers, $this);
-
-        wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
-            $containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
-
-        $unsaved_data_msg = array(
-            'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
-                'event_espresso'), $this->_cpt_object->labels->singular_name),
-            'inputChanged' => 0,
-        );
-        wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
-    }
-
-
-
-    public function load_page_dependencies()
-    {
-        try {
-            $this->_load_page_dependencies();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
-     *
-     * @access protected
-     * @return void
-     */
-    protected function _load_page_dependencies()
-    {
-        //we only add stuff if this is a cpt_route!
-        if ( ! $this->_cpt_route) {
-            parent::_load_page_dependencies();
-            return;
-        }
-        // now let's do some automatic filters into the wp_system
-        // and we'll check to make sure the CHILD class
-        // automatically has the required methods in place.
-        // the following filters are for setting all the redirects
-        // on DEFAULT WP custom post type actions
-        // let's add a hidden input to the post-edit form
-        // so we know when we have to trigger our custom redirects!
-        // Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
-        add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
-        // inject our Admin page nav tabs...
-        // let's make sure the nav tabs are set if they aren't already
-        // if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
-        add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
-        // modify the post_updated messages array
-        add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
-        // add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE,
-        // cpts use the same format for shortlinks as posts!
-        add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
-        // This basically allows us to change the title of the "publish" metabox area
-        // on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
-        if ( ! empty($this->_labels['publishbox'])) {
-            $box_label = is_array($this->_labels['publishbox'])
-                         && isset($this->_labels['publishbox'][$this->_req_action])
-                    ? $this->_labels['publishbox'][$this->_req_action]
-                    : $this->_labels['publishbox'];
-            add_meta_box(
-                'submitdiv',
-                $box_label,
-                'post_submit_meta_box',
-                $this->_cpt_routes[$this->_req_action],
-                'side',
-                'core'
-            );
-        }
-        //let's add page_templates metabox if this cpt added support for it.
-        if ($this->_supports_page_templates($this->_cpt_object->name)) {
-            add_meta_box(
-                'page_templates',
-                __('Page Template', 'event_espresso'),
-                array($this, 'page_template_meta_box'),
-                $this->_cpt_routes[$this->_req_action],
-                'side',
-                'default'
-            );
-        }
-        //this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
-        if (method_exists($this, 'extra_permalink_field_buttons')) {
-            add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
-        }
-        //add preview button
-        add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
-        //insert our own post_stati dropdown
-        add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
-        //This allows adding additional information to the publish post submitbox on the wp post edit form
-        if (method_exists($this, 'extra_misc_actions_publish_box')) {
-            add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
-        }
-        // This allows for adding additional stuff after the title field on the wp post edit form.
-        // This is also before the wp_editor for post description field.
-        if (method_exists($this, 'edit_form_after_title')) {
-            add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
-        }
-        /**
-         * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
-         */
-        add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
-        parent::_load_page_dependencies();
-        // notice we are ALSO going to load the pagenow hook set for this route
-        // (see _before_page_setup for the reset of the pagenow global ).
-        // This is for any plugins that are doing things properly
-        // and hooking into the load page hook for core wp cpt routes.
-        global $pagenow;
-        do_action('load-' . $pagenow);
-        $this->modify_current_screen();
-        add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
-        //we route REALLY early.
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Since we don't want users going to default core wp routes, this will check any wp urls run through the
-     * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
-     * route instead.
-     *
-     * @param string $good_protocol_url The escaped url.
-     * @param string $original_url      The original url.
-     * @param string $_context          The context sent to the esc_url method.
-     * @return string possibly a new url for our route.
-     */
-    public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
-    {
-        $routes_to_match = array(
-            0 => array(
-                'edit.php?post_type=espresso_attendees',
-                'admin.php?page=espresso_registrations&action=contact_list',
-            ),
-            1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
-            ),
-        );
-        foreach ($routes_to_match as $route_matches) {
-            if (strpos($good_protocol_url, $route_matches[0]) !== false) {
-                return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
-            }
-        }
-        return $good_protocol_url;
-    }
-
-
-
-    /**
-     * Determine whether the current cpt supports page templates or not.
-     *
-     * @since %VER%
-     * @param string $cpt_name The cpt slug we're checking on.
-     * @return bool True supported, false not.
-     */
-    private function _supports_page_templates($cpt_name)
-    {
-
-        $cpt_args = EE_Register_CPTs::get_CPTs();
-        $cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
-        $cpt_has_support = ! empty($cpt_args['page_templates']);
-
-        //if the installed version of WP is > 4.7 we do some additional checks.
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
-            $post_templates = wp_get_theme()->get_post_templates();
-            //if there are $post_templates for this cpt, then we return false for this method because
-            //that means we aren't going to load our page template manager and leave that up to the native
-            //cpt template manager.
-            $cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
-        }
-
-        return $cpt_has_support;
-    }
-
-
-    /**
-     * Callback for the page_templates metabox selector.
-     *
-     * @since %VER%
-     * @return void
-     */
-    public function page_template_meta_box()
-    {
-        global $post;
-        $template = '';
-
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
-            $page_template_count = count(get_page_templates());
-        } else {
-            $page_template_count = count(get_page_templates($post));
-        };
-
-        if ($page_template_count) {
-            $page_template = get_post_meta($post->ID, '_wp_page_template', true);
-            $template      = ! empty($page_template) ? $page_template : '';
-        }
-        ?>
+		//filter _autosave_containers
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
+			$this->_autosave_containers, $this);
+		$containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+			$containers, $this);
+
+		wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
+			$containers); //todo once we enable autosaves, this needs to be switched to localize with "cpt-autosave"
+
+		$unsaved_data_msg = array(
+			'eventmsg'     => sprintf(__("The changes you made to this %s will be lost if you navigate away from this page.",
+				'event_espresso'), $this->_cpt_object->labels->singular_name),
+			'inputChanged' => 0,
+		);
+		wp_localize_script('event_editor_js', 'UNSAVED_DATA_MSG', $unsaved_data_msg);
+	}
+
+
+
+	public function load_page_dependencies()
+	{
+		try {
+			$this->_load_page_dependencies();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * overloading the EE_Admin_Page parent load_page_dependencies so we can get the cpt stuff added in appropriately
+	 *
+	 * @access protected
+	 * @return void
+	 */
+	protected function _load_page_dependencies()
+	{
+		//we only add stuff if this is a cpt_route!
+		if ( ! $this->_cpt_route) {
+			parent::_load_page_dependencies();
+			return;
+		}
+		// now let's do some automatic filters into the wp_system
+		// and we'll check to make sure the CHILD class
+		// automatically has the required methods in place.
+		// the following filters are for setting all the redirects
+		// on DEFAULT WP custom post type actions
+		// let's add a hidden input to the post-edit form
+		// so we know when we have to trigger our custom redirects!
+		// Otherwise the redirects will happen on ALL post saves which wouldn't be good of course!
+		add_action('edit_form_after_title', array($this, 'cpt_post_form_hidden_input'));
+		// inject our Admin page nav tabs...
+		// let's make sure the nav tabs are set if they aren't already
+		// if ( empty( $this->_nav_tabs ) ) $this->_set_nav_tabs();
+		add_action('post_edit_form_tag', array($this, 'inject_nav_tabs'));
+		// modify the post_updated messages array
+		add_action('post_updated_messages', array($this, 'post_update_messages'), 10);
+		// add shortlink button to cpt edit screens.  We can do this as a universal thing BECAUSE,
+		// cpts use the same format for shortlinks as posts!
+		add_filter('pre_get_shortlink', array($this, 'add_shortlink_button_to_editor'), 10, 4);
+		// This basically allows us to change the title of the "publish" metabox area
+		// on CPT pages by setting a 'publishbox' value in the $_labels property array in the child class.
+		if ( ! empty($this->_labels['publishbox'])) {
+			$box_label = is_array($this->_labels['publishbox'])
+						 && isset($this->_labels['publishbox'][$this->_req_action])
+					? $this->_labels['publishbox'][$this->_req_action]
+					: $this->_labels['publishbox'];
+			add_meta_box(
+				'submitdiv',
+				$box_label,
+				'post_submit_meta_box',
+				$this->_cpt_routes[$this->_req_action],
+				'side',
+				'core'
+			);
+		}
+		//let's add page_templates metabox if this cpt added support for it.
+		if ($this->_supports_page_templates($this->_cpt_object->name)) {
+			add_meta_box(
+				'page_templates',
+				__('Page Template', 'event_espresso'),
+				array($this, 'page_template_meta_box'),
+				$this->_cpt_routes[$this->_req_action],
+				'side',
+				'default'
+			);
+		}
+		//this is a filter that allows the addition of extra html after the permalink field on the wp post edit-form
+		if (method_exists($this, 'extra_permalink_field_buttons')) {
+			add_filter('get_sample_permalink_html', array($this, 'extra_permalink_field_buttons'), 10, 4);
+		}
+		//add preview button
+		add_filter('get_sample_permalink_html', array($this, 'preview_button_html'), 5, 4);
+		//insert our own post_stati dropdown
+		add_action('post_submitbox_misc_actions', array($this, 'custom_post_stati_dropdown'), 10);
+		//This allows adding additional information to the publish post submitbox on the wp post edit form
+		if (method_exists($this, 'extra_misc_actions_publish_box')) {
+			add_action('post_submitbox_misc_actions', array($this, 'extra_misc_actions_publish_box'), 10);
+		}
+		// This allows for adding additional stuff after the title field on the wp post edit form.
+		// This is also before the wp_editor for post description field.
+		if (method_exists($this, 'edit_form_after_title')) {
+			add_action('edit_form_after_title', array($this, 'edit_form_after_title'), 10);
+		}
+		/**
+		 * Filtering WP's esc_url to capture urls pointing to core wp routes so they point to our route.
+		 */
+		add_filter('clean_url', array($this, 'switch_core_wp_urls_with_ours'), 10, 3);
+		parent::_load_page_dependencies();
+		// notice we are ALSO going to load the pagenow hook set for this route
+		// (see _before_page_setup for the reset of the pagenow global ).
+		// This is for any plugins that are doing things properly
+		// and hooking into the load page hook for core wp cpt routes.
+		global $pagenow;
+		do_action('load-' . $pagenow);
+		$this->modify_current_screen();
+		add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
+		//we route REALLY early.
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Since we don't want users going to default core wp routes, this will check any wp urls run through the
+	 * esc_url() method and if we see a url matching a pattern for our routes, we'll modify it to point to OUR
+	 * route instead.
+	 *
+	 * @param string $good_protocol_url The escaped url.
+	 * @param string $original_url      The original url.
+	 * @param string $_context          The context sent to the esc_url method.
+	 * @return string possibly a new url for our route.
+	 */
+	public function switch_core_wp_urls_with_ours($good_protocol_url, $original_url, $_context)
+	{
+		$routes_to_match = array(
+			0 => array(
+				'edit.php?post_type=espresso_attendees',
+				'admin.php?page=espresso_registrations&action=contact_list',
+			),
+			1 => array(
+				'edit.php?post_type=' . $this->_cpt_object->name,
+				'admin.php?page=' . $this->_cpt_object->name,
+			),
+		);
+		foreach ($routes_to_match as $route_matches) {
+			if (strpos($good_protocol_url, $route_matches[0]) !== false) {
+				return str_replace($route_matches[0], $route_matches[1], $good_protocol_url);
+			}
+		}
+		return $good_protocol_url;
+	}
+
+
+
+	/**
+	 * Determine whether the current cpt supports page templates or not.
+	 *
+	 * @since %VER%
+	 * @param string $cpt_name The cpt slug we're checking on.
+	 * @return bool True supported, false not.
+	 */
+	private function _supports_page_templates($cpt_name)
+	{
+
+		$cpt_args = EE_Register_CPTs::get_CPTs();
+		$cpt_args = isset($cpt_args[$cpt_name]) ? $cpt_args[$cpt_name]['args'] : array();
+		$cpt_has_support = ! empty($cpt_args['page_templates']);
+
+		//if the installed version of WP is > 4.7 we do some additional checks.
+		if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+			$post_templates = wp_get_theme()->get_post_templates();
+			//if there are $post_templates for this cpt, then we return false for this method because
+			//that means we aren't going to load our page template manager and leave that up to the native
+			//cpt template manager.
+			$cpt_has_support = ! isset($post_templates[$cpt_name]) ? $cpt_has_support : false;
+		}
+
+		return $cpt_has_support;
+	}
+
+
+	/**
+	 * Callback for the page_templates metabox selector.
+	 *
+	 * @since %VER%
+	 * @return void
+	 */
+	public function page_template_meta_box()
+	{
+		global $post;
+		$template = '';
+
+		if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+			$page_template_count = count(get_page_templates());
+		} else {
+			$page_template_count = count(get_page_templates($post));
+		};
+
+		if ($page_template_count) {
+			$page_template = get_post_meta($post->ID, '_wp_page_template', true);
+			$template      = ! empty($page_template) ? $page_template : '';
+		}
+		?>
         <p><strong><?php _e('Template') ?></strong></p>
         <label class="screen-reader-text" for="page_template"><?php _e('Page Template') ?></label><select
             name="page_template" id="page_template">
@@ -495,450 +495,450 @@ 
         <?php page_template_dropdown($template); ?>
     </select>
         <?php
-    }
-
-
-
-    /**
-     * if this post is a draft or scheduled post then we provide a preview button for user to click
-     * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
-     *
-     * @param  string $return    the current html
-     * @param  int    $id        the post id for the page
-     * @param  string $new_title What the title is
-     * @param  string $new_slug  what the slug is
-     * @return string            The new html string for the permalink area
-     */
-    public function preview_button_html($return, $id, $new_title, $new_slug)
-    {
-        $post = get_post($id);
-        if ('publish' !== get_post_status($post)) {
-            //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
-            $return .= '<span_id="view-post-btn"><a target="_blank" href="'
-                       . get_preview_post_link($id)
-                       . '" class="button button-small">'
-                       . __('Preview', 'event_espresso')
-                       . '</a></span>'
-                       . "\n";
-        }
-        return $return;
-    }
-
-
-
-    /**
-     * add our custom post stati dropdown on the wp post page for this cpt
-     *
-     * @return void
-     */
-    public function custom_post_stati_dropdown()
-    {
-
-        $statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
-        $cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
-            ? $statuses[$this->_cpt_model_obj->status()]
-            : '';
-        $template_args    = array(
-            'cur_status'            => $this->_cpt_model_obj->status(),
-            'statuses'              => $statuses,
-            'cur_status_label'      => $cur_status_label,
-            'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
-        );
-        //we'll add a trash post status (WP doesn't add one for some reason)
-        if ($this->_cpt_model_obj->status() === 'trash') {
-            $template_args['cur_status_label'] = __('Trashed', 'event_espresso');
-            $statuses['trash']                 = __('Trashed', 'event_espresso');
-            $template_args['statuses']         = $statuses;
-        }
-
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
-        EEH_Template::display_template($template, $template_args);
-    }
-
-
-
-    public function setup_autosave_hooks()
-    {
-        $this->_set_autosave_containers();
-        $this->_load_autosave_scripts_styles();
-    }
-
-
-
-    /**
-     * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
-     * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
-     * for the nonce in here, but then this method looks for two things:
-     * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
-     * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
-     * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
-     * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
-     * template args.
-     *    1. $template_args['error'] = IF there is an error you can add the message in here.
-     *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
-     *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
-     *    $this->_template_args['data']['items'] = array(
-     *        'event-datetime-ids' => '1,2,3';
-     *    );
-     *    Keep in mind the following things:
-     *    - "where" index is for the input with the id as that string.
-     *    - "what" index is what will be used for the value of that input.
-     *
-     * @return void
-     */
-    public function do_extra_autosave_stuff()
-    {
-        //next let's check for the autosave nonce (we'll use _verify_nonce )
-        $nonce = isset($this->_req_data['autosavenonce'])
-                ? $this->_req_data['autosavenonce']
-                : null;
-        $this->_verify_nonce($nonce, 'autosave');
-        //make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
-        if ( ! defined('DOING_AUTOSAVE')) {
-            define('DOING_AUTOSAVE', true);
-        }
-        //if we made it here then the nonce checked out.  Let's run our methods and actions
-        $autosave = "_ee_autosave_{$this->_current_view}";
-        if (method_exists($this, $autosave)) {
-            $this->$autosave();
-        } else {
-            $this->_template_args['success'] = true;
-        }
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
-        //now let's return json
-        $this->_return_json();
-    }
-
-
-
-    /**
-     * This takes care of setting up default routes and pages that utilize the core WP admin pages.
-     * Child classes can override the defaults (in cases for adding metaboxes etc.)
-     * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
-     *
-     * @access protected
-     * @throws EE_Error
-     * @return void
-     */
-    protected function _extend_page_config_for_cpt()
-    {
-        //before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
-        if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) {
-            return;
-        }
-        //set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
-        if ( ! empty($this->_cpt_object)) {
-            $this->_page_routes = array_merge(array(
-                'create_new' => '_create_new_cpt_item',
-                'edit'       => '_edit_cpt_item',
-            ), $this->_page_routes);
-            $this->_page_config = array_merge(array(
-                'create_new' => array(
-                    'nav'           => array(
-                        'label' => $this->_cpt_object->labels->add_new_item,
-                        'order' => 5,
-                    ),
-                    'require_nonce' => false,
-                ),
-                'edit'       => array(
-                    'nav'           => array(
-                        'label'      => $this->_cpt_object->labels->edit_item,
-                        'order'      => 5,
-                        'persistent' => false,
-                        'url'        => '',
-                    ),
-                    'require_nonce' => false,
-                ),
-            ),
-                $this->_page_config
-            );
-        }
-        //load the next section only if this is a matching cpt route as set in the cpt routes array.
-        if ( ! isset($this->_cpt_routes[$this->_req_action])) {
-            return;
-        }
-        $this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
-        //add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
-        if (empty($this->_cpt_object)) {
-            $msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
-                $this->page_slug, $this->_req_action, get_class($this));
-            throw new EE_Error($msg);
-        }
-        if ($this->_cpt_route) {
-            $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-            $this->_set_model_object($id);
-        }
-    }
-
-
-
-    /**
-     * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
-     *
-     * @access protected
-     * @param int  $id The id to retrieve the model object for. If empty we set a default object.
-     * @param bool $ignore_route_check
-     * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
-     * @throws EE_Error
-     */
-    protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '')
-    {
-        $model = null;
-        if (
-            empty($this->_cpt_model_names)
-            || (
-                ! $ignore_route_check
-                && ! isset($this->_cpt_routes[$this->_req_action])
-            ) || (
-                $this->_cpt_model_obj instanceof EE_CPT_Base
-                && $this->_cpt_model_obj->ID() === $id
-            )
-        ) {
-            //get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
-            return;
-        }
-        //if ignore_route_check is true, then get the model name via EE_Register_CPTs
-        if ($ignore_route_check) {
-            $model_names = EE_Register_CPTs::get_cpt_model_names();
-            $post_type   = get_post_type($id);
-            if (isset($model_names[$post_type])) {
-                $model = EE_Registry::instance()->load_model($model_names[$post_type]);
-            }
-        } else {
-            $model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
-        }
-        if ($model instanceof EEM_Base) {
-            $this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
-        }
-        do_action(
-            'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
-            $this->_cpt_model_obj,
-            $req_type
-        );
-    }
-
-
-
-    /**
-     * admin_init_global
-     * This runs all the code that we want executed within the WP admin_init hook.
-     * This method executes for ALL EE Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_init_global()
-    {
-        $post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
-        //its possible this is a new save so let's catch that instead
-        $post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
-        $post_type = $post ? $post->post_type : false;
-        $current_route = isset($this->_req_data['current_route'])
-            ? $this->_req_data['current_route']
-            : 'shouldneverwork';
-        $route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
-            ? $this->_cpt_routes[$current_route]
-            : '';
-        add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
-        add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
-        if ($post_type === $route_to_check) {
-            add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
-        }
-        //now let's filter redirect if we're on a revision page and the revision is for an event CPT.
-        $revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        if ( ! empty($revision)) {
-            $action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
-            //doing a restore?
-            if ( ! empty($action) && $action === 'restore') {
-                //get post for revision
-                $rev_post = get_post($revision);
-                $rev_parent = get_post($rev_post->post_parent);
-                //only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
-                if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
-                    add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
-                    //restores of revisions
-                    add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
-                }
-            }
-        }
-        //NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
-        if ($post_type && $post_type === $route_to_check) {
-            //$post_id, $post
-            add_action('save_post', array($this, 'insert_update'), 10, 3);
-            //$post_id
-            add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
-            add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
-            add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
-            add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
-        }
-    }
-
-
-
-    /**
-     * Callback for the WordPress trashed_post hook.
-     * Execute some basic checks before calling the trash_cpt_item declared in the child class.
-     *
-     * @param int $post_id
-     * @throws \EE_Error
-     */
-    public function before_trash_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'trash');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->trash_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress untrashed_post hook.
-     * Execute some basic checks before calling the restore_cpt_method in the child class.
-     *
-     * @param $post_id
-     * @throws \EE_Error
-     */
-    public function before_restore_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'restore');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->restore_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * Callback for the WordPress after_delete_post hook.
-     * Execute some basic checks before calling the delete_cpt_item method in the child class.
-     *
-     * @param $post_id
-     * @throws \EE_Error
-     */
-    public function before_delete_cpt_item($post_id)
-    {
-        $this->_set_model_object($post_id, true, 'delete');
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
-            return;
-        }
-        $this->delete_cpt_item($post_id);
-    }
-
-
-
-    /**
-     * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
-     * accordingly.
-     *
-     * @access public
-     * @throws EE_Error
-     * @return void
-     */
-    public function verify_cpt_object()
-    {
-        $label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
-        // verify event object
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
-                    'event_espresso'), $label));
-        }
-        //if auto-draft then throw an error
-        if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
-            EE_Error::overwrite_errors();
-            EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
-                    $label), __FILE__, __FUNCTION__, __LINE__);
-        }
-    }
-
-
-
-    /**
-     * admin_footer_scripts_global
-     * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
-     * will apply on ALL EE_Admin pages.
-     *
-     * @access public
-     * @return void
-     */
-    public function admin_footer_scripts_global()
-    {
-        $this->_add_admin_page_ajax_loading_img();
-        $this->_add_admin_page_overlay();
-    }
-
-
-
-    /**
-     * add in any global scripts for cpt routes
-     *
-     * @return void
-     */
-    public function load_global_scripts_styles()
-    {
-        parent::load_global_scripts_styles();
-        if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
-            //setup custom post status object for localize script but only if we've got a cpt object
-            $statuses = $this->_cpt_model_obj->get_custom_post_statuses();
-            if ( ! empty($statuses)) {
-                //get ALL statuses!
-                $statuses = $this->_cpt_model_obj->get_all_post_statuses();
-                //setup object
-                $ee_cpt_statuses = array();
-                foreach ($statuses as $status => $label) {
-                    $ee_cpt_statuses[$status] = array(
-                        'label'      => $label,
-                        'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
-                    );
-                }
-                wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
-            }
-        }
-    }
-
-
-
-    /**
-     * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
-     * insert/updates
-     *
-     * @param  int     $post_id ID of post being updated
-     * @param  WP_Post $post    Post object from WP
-     * @param  bool    $update  Whether this is an update or a new save.
-     * @return void
-     * @throws \EE_Error
-     */
-    public function insert_update($post_id, $post, $update)
-    {
-        //make sure that if this is a revision OR trash action that we don't do any updates!
-        if (
-            isset($this->_req_data['action'])
-            && (
-                $this->_req_data['action'] === 'restore'
-                || $this->_req_data['action'] === 'trash'
-            )
-        ) {
-            return;
-        }
-        $this->_set_model_object($post_id, true, 'insert_update');
-        //if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
-        if ($update
-            && (
-                ! $this->_cpt_model_obj instanceof EE_CPT_Base
-                || $this->_cpt_model_obj->ID() !== $post_id
-            )
-        ) {
-            return;
-        }
-        //check for autosave and update our req_data property accordingly.
-        /*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
+	}
+
+
+
+	/**
+	 * if this post is a draft or scheduled post then we provide a preview button for user to click
+	 * Method is called from parent and is hooked into the wp 'get_sample_permalink_html' filter.
+	 *
+	 * @param  string $return    the current html
+	 * @param  int    $id        the post id for the page
+	 * @param  string $new_title What the title is
+	 * @param  string $new_slug  what the slug is
+	 * @return string            The new html string for the permalink area
+	 */
+	public function preview_button_html($return, $id, $new_title, $new_slug)
+	{
+		$post = get_post($id);
+		if ('publish' !== get_post_status($post)) {
+			//include shims for the `get_preview_post_link` function
+			require_once( EE_CORE . 'wordpress-shims.php' );
+			$return .= '<span_id="view-post-btn"><a target="_blank" href="'
+					   . get_preview_post_link($id)
+					   . '" class="button button-small">'
+					   . __('Preview', 'event_espresso')
+					   . '</a></span>'
+					   . "\n";
+		}
+		return $return;
+	}
+
+
+
+	/**
+	 * add our custom post stati dropdown on the wp post page for this cpt
+	 *
+	 * @return void
+	 */
+	public function custom_post_stati_dropdown()
+	{
+
+		$statuses         = $this->_cpt_model_obj->get_custom_post_statuses();
+		$cur_status_label = array_key_exists($this->_cpt_model_obj->status(), $statuses)
+			? $statuses[$this->_cpt_model_obj->status()]
+			: '';
+		$template_args    = array(
+			'cur_status'            => $this->_cpt_model_obj->status(),
+			'statuses'              => $statuses,
+			'cur_status_label'      => $cur_status_label,
+			'localized_status_save' => sprintf(__('Save %s', 'event_espresso'), $cur_status_label),
+		);
+		//we'll add a trash post status (WP doesn't add one for some reason)
+		if ($this->_cpt_model_obj->status() === 'trash') {
+			$template_args['cur_status_label'] = __('Trashed', 'event_espresso');
+			$statuses['trash']                 = __('Trashed', 'event_espresso');
+			$template_args['statuses']         = $statuses;
+		}
+
+		$template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+		EEH_Template::display_template($template, $template_args);
+	}
+
+
+
+	public function setup_autosave_hooks()
+	{
+		$this->_set_autosave_containers();
+		$this->_load_autosave_scripts_styles();
+	}
+
+
+
+	/**
+	 * This is run on all WordPress autosaves AFTER the autosave is complete and sends along a $_POST object (available
+	 * in $this->_req_data) containing: post_ID of the saved post autosavenonce for the saved post We'll do the check
+	 * for the nonce in here, but then this method looks for two things:
+	 * 1. Execute a method (if exists) matching 'ee_autosave_' and appended with the given route. OR
+	 * 2. do_actions() for global or class specific actions that have been registered (for plugins/addons not in an
+	 * EE_Admin_Page class. PLEASE NOTE: Data will be returned using the _return_json() object and so the
+	 * $_template_args property should be used to hold the $data array.  We're expecting the following things set in
+	 * template args.
+	 *    1. $template_args['error'] = IF there is an error you can add the message in here.
+	 *    2. $template_args['data']['items'] = an array of items that are setup in key index pairs of 'where_values_go'
+	 *    => 'values_to_add'.  In other words, for the datetime metabox we'll have something like
+	 *    $this->_template_args['data']['items'] = array(
+	 *        'event-datetime-ids' => '1,2,3';
+	 *    );
+	 *    Keep in mind the following things:
+	 *    - "where" index is for the input with the id as that string.
+	 *    - "what" index is what will be used for the value of that input.
+	 *
+	 * @return void
+	 */
+	public function do_extra_autosave_stuff()
+	{
+		//next let's check for the autosave nonce (we'll use _verify_nonce )
+		$nonce = isset($this->_req_data['autosavenonce'])
+				? $this->_req_data['autosavenonce']
+				: null;
+		$this->_verify_nonce($nonce, 'autosave');
+		//make sure we define doing autosave (cause WP isn't triggering this we want to make sure we define it)
+		if ( ! defined('DOING_AUTOSAVE')) {
+			define('DOING_AUTOSAVE', true);
+		}
+		//if we made it here then the nonce checked out.  Let's run our methods and actions
+		$autosave = "_ee_autosave_{$this->_current_view}";
+		if (method_exists($this, $autosave)) {
+			$this->$autosave();
+		} else {
+			$this->_template_args['success'] = true;
+		}
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
+		do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+		//now let's return json
+		$this->_return_json();
+	}
+
+
+
+	/**
+	 * This takes care of setting up default routes and pages that utilize the core WP admin pages.
+	 * Child classes can override the defaults (in cases for adding metaboxes etc.)
+	 * but take care that you include the defaults here otherwise your core WP admin pages for the cpt won't work!
+	 *
+	 * @access protected
+	 * @throws EE_Error
+	 * @return void
+	 */
+	protected function _extend_page_config_for_cpt()
+	{
+		//before doing anything we need to make sure this runs ONLY when the loaded page matches the set page_slug
+		if (isset($this->_req_data['page']) && $this->_req_data['page'] !== $this->page_slug) {
+			return;
+		}
+		//set page routes and page config but ONLY if we're not viewing a custom setup cpt route as defined in _cpt_routes
+		if ( ! empty($this->_cpt_object)) {
+			$this->_page_routes = array_merge(array(
+				'create_new' => '_create_new_cpt_item',
+				'edit'       => '_edit_cpt_item',
+			), $this->_page_routes);
+			$this->_page_config = array_merge(array(
+				'create_new' => array(
+					'nav'           => array(
+						'label' => $this->_cpt_object->labels->add_new_item,
+						'order' => 5,
+					),
+					'require_nonce' => false,
+				),
+				'edit'       => array(
+					'nav'           => array(
+						'label'      => $this->_cpt_object->labels->edit_item,
+						'order'      => 5,
+						'persistent' => false,
+						'url'        => '',
+					),
+					'require_nonce' => false,
+				),
+			),
+				$this->_page_config
+			);
+		}
+		//load the next section only if this is a matching cpt route as set in the cpt routes array.
+		if ( ! isset($this->_cpt_routes[$this->_req_action])) {
+			return;
+		}
+		$this->_cpt_route = isset($this->_cpt_routes[$this->_req_action]) ? true : false;
+		//add_action('FHEE__EE_Admin_Page___load_page_dependencies__after_load', array( $this, 'modify_current_screen') );
+		if (empty($this->_cpt_object)) {
+			$msg = sprintf(__('This page has been set as being related to a registered custom post type, however, the custom post type object could not be retrieved. There are two possible reasons for this:  1. The "%s" does not match a registered post type. or 2. The custom post type is not registered for the "%s" action as indexed in the "$_cpt_routes" property on this class (%s).'),
+				$this->page_slug, $this->_req_action, get_class($this));
+			throw new EE_Error($msg);
+		}
+		if ($this->_cpt_route) {
+			$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+			$this->_set_model_object($id);
+		}
+	}
+
+
+
+	/**
+	 * Sets the _cpt_model_object property using what has been set for the _cpt_model_name and a given id.
+	 *
+	 * @access protected
+	 * @param int  $id The id to retrieve the model object for. If empty we set a default object.
+	 * @param bool $ignore_route_check
+	 * @param string $req_type whether the current route is for inserting, updating, or deleting the CPT
+	 * @throws EE_Error
+	 */
+	protected function _set_model_object($id = null, $ignore_route_check = false, $req_type = '')
+	{
+		$model = null;
+		if (
+			empty($this->_cpt_model_names)
+			|| (
+				! $ignore_route_check
+				&& ! isset($this->_cpt_routes[$this->_req_action])
+			) || (
+				$this->_cpt_model_obj instanceof EE_CPT_Base
+				&& $this->_cpt_model_obj->ID() === $id
+			)
+		) {
+			//get out cuz we either don't have a model name OR the object has already been set and it has the same id as what has been sent.
+			return;
+		}
+		//if ignore_route_check is true, then get the model name via EE_Register_CPTs
+		if ($ignore_route_check) {
+			$model_names = EE_Register_CPTs::get_cpt_model_names();
+			$post_type   = get_post_type($id);
+			if (isset($model_names[$post_type])) {
+				$model = EE_Registry::instance()->load_model($model_names[$post_type]);
+			}
+		} else {
+			$model = EE_Registry::instance()->load_model($this->_cpt_model_names[$this->_req_action]);
+		}
+		if ($model instanceof EEM_Base) {
+			$this->_cpt_model_obj = ! empty($id) ? $model->get_one_by_ID($id) : $model->create_default_object();
+		}
+		do_action(
+			'AHEE__EE_Admin_Page_CPT__set_model_object__after_set_object',
+			$this->_cpt_model_obj,
+			$req_type
+		);
+	}
+
+
+
+	/**
+	 * admin_init_global
+	 * This runs all the code that we want executed within the WP admin_init hook.
+	 * This method executes for ALL EE Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_init_global()
+	{
+		$post = isset($this->_req_data['post']) ? get_post($this->_req_data['post']) : null;
+		//its possible this is a new save so let's catch that instead
+		$post = isset($this->_req_data['post_ID']) ? get_post($this->_req_data['post_ID']) : $post;
+		$post_type = $post ? $post->post_type : false;
+		$current_route = isset($this->_req_data['current_route'])
+			? $this->_req_data['current_route']
+			: 'shouldneverwork';
+		$route_to_check = $post_type && isset($this->_cpt_routes[$current_route])
+			? $this->_cpt_routes[$current_route]
+			: '';
+		add_filter('get_delete_post_link', array($this, 'modify_delete_post_link'), 10, 3);
+		add_filter('get_edit_post_link', array($this, 'modify_edit_post_link'), 10, 3);
+		if ($post_type === $route_to_check) {
+			add_filter('redirect_post_location', array($this, 'cpt_post_location_redirect'), 10, 2);
+		}
+		//now let's filter redirect if we're on a revision page and the revision is for an event CPT.
+		$revision = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		if ( ! empty($revision)) {
+			$action = isset($this->_req_data['action']) ? $this->_req_data['action'] : null;
+			//doing a restore?
+			if ( ! empty($action) && $action === 'restore') {
+				//get post for revision
+				$rev_post = get_post($revision);
+				$rev_parent = get_post($rev_post->post_parent);
+				//only do our redirect filter AND our restore revision action if the post_type for the parent is one of our cpts.
+				if ($rev_parent && $rev_parent->post_type === $this->page_slug) {
+					add_filter('wp_redirect', array($this, 'revision_redirect'), 10, 2);
+					//restores of revisions
+					add_action('wp_restore_post_revision', array($this, 'restore_revision'), 10, 2);
+				}
+			}
+		}
+		//NOTE we ONLY want to run these hooks if we're on the right class for the given post type.  Otherwise we could see some really freaky things happen!
+		if ($post_type && $post_type === $route_to_check) {
+			//$post_id, $post
+			add_action('save_post', array($this, 'insert_update'), 10, 3);
+			//$post_id
+			add_action('trashed_post', array($this, 'before_trash_cpt_item'), 10);
+			add_action('trashed_post', array($this, 'dont_permanently_delete_ee_cpts'), 10);
+			add_action('untrashed_post', array($this, 'before_restore_cpt_item'), 10);
+			add_action('after_delete_post', array($this, 'before_delete_cpt_item'), 10);
+		}
+	}
+
+
+
+	/**
+	 * Callback for the WordPress trashed_post hook.
+	 * Execute some basic checks before calling the trash_cpt_item declared in the child class.
+	 *
+	 * @param int $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_trash_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'trash');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->trash_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress untrashed_post hook.
+	 * Execute some basic checks before calling the restore_cpt_method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_restore_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'restore');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->restore_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * Callback for the WordPress after_delete_post hook.
+	 * Execute some basic checks before calling the delete_cpt_item method in the child class.
+	 *
+	 * @param $post_id
+	 * @throws \EE_Error
+	 */
+	public function before_delete_cpt_item($post_id)
+	{
+		$this->_set_model_object($post_id, true, 'delete');
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base || $this->_cpt_model_obj->ID() !== $post_id) {
+			return;
+		}
+		$this->delete_cpt_item($post_id);
+	}
+
+
+
+	/**
+	 * This simply verifies if the cpt_model_object is instantiated for the given page and throws an error message
+	 * accordingly.
+	 *
+	 * @access public
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public function verify_cpt_object()
+	{
+		$label = ! empty($this->_cpt_object) ? $this->_cpt_object->labels->singular_name : $this->page_label;
+		// verify event object
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			throw new EE_Error(sprintf(__('Something has gone wrong with the page load because we are unable to set up the object for the %1$s.  This usually happens when the given id for the page route is NOT for the correct custom post type for this page',
+					'event_espresso'), $label));
+		}
+		//if auto-draft then throw an error
+		if ($this->_cpt_model_obj->get('status') === 'auto-draft') {
+			EE_Error::overwrite_errors();
+			EE_Error::add_error(sprintf(__('This %1$s was saved without a title, description, or excerpt which means that none of the extra details you added were saved properly.  All autodrafts will show up in the "draft" view of your event list table.  You can delete them from there. Please click the "Add %1$s" button to refresh and restart.'),
+					$label), __FILE__, __FUNCTION__, __LINE__);
+		}
+	}
+
+
+
+	/**
+	 * admin_footer_scripts_global
+	 * Anything triggered by the 'admin_print_footer_scripts' WP hook should be put in here. This particular method
+	 * will apply on ALL EE_Admin pages.
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function admin_footer_scripts_global()
+	{
+		$this->_add_admin_page_ajax_loading_img();
+		$this->_add_admin_page_overlay();
+	}
+
+
+
+	/**
+	 * add in any global scripts for cpt routes
+	 *
+	 * @return void
+	 */
+	public function load_global_scripts_styles()
+	{
+		parent::load_global_scripts_styles();
+		if ($this->_cpt_model_obj instanceof EE_CPT_Base) {
+			//setup custom post status object for localize script but only if we've got a cpt object
+			$statuses = $this->_cpt_model_obj->get_custom_post_statuses();
+			if ( ! empty($statuses)) {
+				//get ALL statuses!
+				$statuses = $this->_cpt_model_obj->get_all_post_statuses();
+				//setup object
+				$ee_cpt_statuses = array();
+				foreach ($statuses as $status => $label) {
+					$ee_cpt_statuses[$status] = array(
+						'label'      => $label,
+						'save_label' => sprintf(__('Save as %s', 'event_espresso'), $label),
+					);
+				}
+				wp_localize_script('ee_admin_js', 'eeCPTstatuses', $ee_cpt_statuses);
+			}
+		}
+	}
+
+
+
+	/**
+	 * This is a wrapper for the insert/update routes for cpt items so we can add things that are common to ALL
+	 * insert/updates
+	 *
+	 * @param  int     $post_id ID of post being updated
+	 * @param  WP_Post $post    Post object from WP
+	 * @param  bool    $update  Whether this is an update or a new save.
+	 * @return void
+	 * @throws \EE_Error
+	 */
+	public function insert_update($post_id, $post, $update)
+	{
+		//make sure that if this is a revision OR trash action that we don't do any updates!
+		if (
+			isset($this->_req_data['action'])
+			&& (
+				$this->_req_data['action'] === 'restore'
+				|| $this->_req_data['action'] === 'trash'
+			)
+		) {
+			return;
+		}
+		$this->_set_model_object($post_id, true, 'insert_update');
+		//if our cpt object is not instantiated and its NOT the same post_id as what is triggering this callback, then exit.
+		if ($update
+			&& (
+				! $this->_cpt_model_obj instanceof EE_CPT_Base
+				|| $this->_cpt_model_obj->ID() !== $post_id
+			)
+		) {
+			return;
+		}
+		//check for autosave and update our req_data property accordingly.
+		/*if ( defined('DOING_AUTOSAVE') && DOING_AUTOSAVE && isset( $this->_req_data['ee_autosave_data'] ) ) {
             foreach( (array) $this->_req_data['ee_autosave_data'] as $id => $values ) {
 
                 foreach ( (array) $values as $key => $value ) {
@@ -948,542 +948,542 @@ 
 
         }/**/ //TODO reactivate after autosave is implemented in 4.2
 
-        //take care of updating any selected page_template IF this cpt supports it.
-        if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
-            //wp version aware.
-            if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
-                $page_templates = wp_get_theme()->get_page_templates();
-            } else {
-                $post->page_template = $this->_req_data['page_template'];
-                $page_templates      = wp_get_theme()->get_page_templates($post);
-            }
-            if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
-                EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
-            } else {
-                update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
-            }
-        }
-        if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
-            return;
-        } //TODO we'll remove this after reimplementing autosave in 4.2
-        $this->_insert_update_cpt_item($post_id, $post);
-    }
-
-
-
-    /**
-     * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
-     * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
-     * so we don't have to check for our CPT.
-     *
-     * @param  int $post_id ID of the post
-     * @return void
-     */
-    public function dont_permanently_delete_ee_cpts($post_id)
-    {
-        //only do this if we're actually processing one of our CPTs
-        //if our cpt object isn't existent then get out immediately.
-        if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
-            return;
-        }
-        delete_post_meta($post_id, '_wp_trash_meta_status');
-        delete_post_meta($post_id, '_wp_trash_meta_time');
-        //our cpts may have comments so let's take care of that too
-        delete_post_meta($post_id, '_wp_trash_meta_comments_status');
-    }
-
-
-
-    /**
-     * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
-     * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
-     * in them. We also have our OWN action in here so addons can hook into the restore process easily.
-     *
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision being restored
-     * @return void
-     */
-    public function restore_revision($post_id, $revision_id)
-    {
-        $this->_restore_cpt_item($post_id, $revision_id);
-        //global action
-        do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
-        //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
-    }
-
-
-
-    /**
-     * @see restore_revision() for details
-     * @param  int $post_id     ID of cpt item
-     * @param  int $revision_id ID of revision for item
-     * @return void
-     */
-    abstract protected function _restore_cpt_item($post_id, $revision_id);
-
-
-
-    /**
-     * Execution of this method is added to the end of the load_page_dependencies method in the parent
-     * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
-     * To fix we have to reset the current_screen using the page_slug
-     * (which is identical - or should be - to our registered_post_type id.)
-     * Also, since the core WP file loads the admin_header.php for WP
-     * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
-     * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
-     *
-     * @return void
-     */
-    public function modify_current_screen()
-    {
-        //ONLY do this if the current page_route IS a cpt route
-        if ( ! $this->_cpt_route) {
-            return;
-        }
-        //routing things REALLY early b/c this is a cpt admin page
-        set_current_screen($this->_cpt_routes[$this->_req_action]);
-        $this->_current_screen       = get_current_screen();
-        $this->_current_screen->base = 'event-espresso';
-        $this->_add_help_tabs(); //we make sure we add any help tabs back in!
-        /*try {
+		//take care of updating any selected page_template IF this cpt supports it.
+		if ($this->_supports_page_templates($post->post_type) && ! empty($this->_req_data['page_template'])) {
+			//wp version aware.
+			if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
+				$page_templates = wp_get_theme()->get_page_templates();
+			} else {
+				$post->page_template = $this->_req_data['page_template'];
+				$page_templates      = wp_get_theme()->get_page_templates($post);
+			}
+			if ('default' != $this->_req_data['page_template'] && ! isset($page_templates[$this->_req_data['page_template']])) {
+				EE_Error::add_error(__('Invalid Page Template.', 'event_espresso'), __FILE__, __FUNCTION__, __LINE__);
+			} else {
+				update_post_meta($post_id, '_wp_page_template', $this->_req_data['page_template']);
+			}
+		}
+		if (defined('DOING_AUTOSAVE') && DOING_AUTOSAVE) {
+			return;
+		} //TODO we'll remove this after reimplementing autosave in 4.2
+		$this->_insert_update_cpt_item($post_id, $post);
+	}
+
+
+
+	/**
+	 * This hooks into the wp_trash_post() function and removes the `_wp_trash_meta_status` and `_wp_trash_meta_time`
+	 * post meta IF the trashed post is one of our CPT's - note this method should only be called with our cpt routes
+	 * so we don't have to check for our CPT.
+	 *
+	 * @param  int $post_id ID of the post
+	 * @return void
+	 */
+	public function dont_permanently_delete_ee_cpts($post_id)
+	{
+		//only do this if we're actually processing one of our CPTs
+		//if our cpt object isn't existent then get out immediately.
+		if ( ! $this->_cpt_model_obj instanceof EE_CPT_Base) {
+			return;
+		}
+		delete_post_meta($post_id, '_wp_trash_meta_status');
+		delete_post_meta($post_id, '_wp_trash_meta_time');
+		//our cpts may have comments so let's take care of that too
+		delete_post_meta($post_id, '_wp_trash_meta_comments_status');
+	}
+
+
+
+	/**
+	 * This is a wrapper for the restore_cpt_revision route for cpt items so we can make sure that when a revision is
+	 * triggered that we restore related items.  In order to work cpt classes MUST have a restore_cpt_revision method
+	 * in them. We also have our OWN action in here so addons can hook into the restore process easily.
+	 *
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision being restored
+	 * @return void
+	 */
+	public function restore_revision($post_id, $revision_id)
+	{
+		$this->_restore_cpt_item($post_id, $revision_id);
+		//global action
+		do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
+		//class specific action so you can limit hooking into a specific page.
+		do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+	}
+
+
+
+	/**
+	 * @see restore_revision() for details
+	 * @param  int $post_id     ID of cpt item
+	 * @param  int $revision_id ID of revision for item
+	 * @return void
+	 */
+	abstract protected function _restore_cpt_item($post_id, $revision_id);
+
+
+
+	/**
+	 * Execution of this method is added to the end of the load_page_dependencies method in the parent
+	 * so that we can fix a bug where default core metaboxes were not being called in the sidebar.
+	 * To fix we have to reset the current_screen using the page_slug
+	 * (which is identical - or should be - to our registered_post_type id.)
+	 * Also, since the core WP file loads the admin_header.php for WP
+	 * (and there are a bunch of other things edit-form-advanced.php loads that need to happen really early)
+	 * we need to load it NOW, hence our _route_admin_request in here. (Otherwise screen options won't be set).
+	 *
+	 * @return void
+	 */
+	public function modify_current_screen()
+	{
+		//ONLY do this if the current page_route IS a cpt route
+		if ( ! $this->_cpt_route) {
+			return;
+		}
+		//routing things REALLY early b/c this is a cpt admin page
+		set_current_screen($this->_cpt_routes[$this->_req_action]);
+		$this->_current_screen       = get_current_screen();
+		$this->_current_screen->base = 'event-espresso';
+		$this->_add_help_tabs(); //we make sure we add any help tabs back in!
+		/*try {
             $this->_route_admin_request();
         } catch ( EE_Error $e ) {
             $e->get_error();
         }/**/
-    }
-
-
-
-    /**
-     * This allows child classes to modify the default editor title that appears when people add a new or edit an
-     * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
-     * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
-     * default to be.
-     *
-     * @param string $title The new title (or existing if there is no editor_title defined)
-     * @return string
-     */
-    public function add_custom_editor_default_title($title)
-    {
-        return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
-            ? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
-            : $title;
-    }
-
-
-
-    /**
-     * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
-     *
-     * @param string $shortlink   The already generated shortlink
-     * @param int    $id          Post ID for this item
-     * @param string $context     The context for the link
-     * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
-     * @return string
-     */
-    public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
-    {
-        if ( ! empty($id) && get_option('permalink_structure') !== '') {
-            $post = get_post($id);
-            if (isset($post->post_type) && $this->page_slug === $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
-            }
-        }
-        return $shortlink;
-    }
-
-
-
-    /**
-     * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
-     * already run in modify_current_screen())
-     *
-     * @return void
-     */
-    public function route_admin_request()
-    {
-        if ($this->_cpt_route) {
-            return;
-        }
-        try {
-            $this->_route_admin_request();
-        } catch (EE_Error $e) {
-            $e->get_error();
-        }
-    }
-
-
-
-    /**
-     * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
-     *
-     * @return void
-     */
-    public function cpt_post_form_hidden_input()
-    {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
-        //we're also going to add the route value and the current page so we can direct autosave parsing correctly
-        echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
-        echo '</div>';
-    }
-
-
-
-    /**
-     * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
-     *
-     * @param  string $location Original location url
-     * @param  int    $status   Status for http header
-     * @return string           new (or original) url to redirect to.
-     */
-    public function revision_redirect($location, $status)
-    {
-        //get revision
-        $rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
-        //can't do anything without revision so let's get out if not present
-        if (empty($rev_id)) {
-            return $location;
-        }
-        //get rev_post_data
-        $rev = get_post($rev_id);
-        $admin_url = $this->_admin_base_url;
-        $query_args = array(
-            'action'   => 'edit',
-            'post'     => $rev->post_parent,
-            'revision' => $rev_id,
-            'message'  => 5,
-        );
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
-     *
-     * @param  string $link    the original generated link
-     * @param  int    $id      post id
-     * @param  string $context optional, defaults to display.  How to write the '&'
-     * @return string          the link
-     */
-    public function modify_edit_post_link($link, $id, $context)
-    {
-        $post = get_post($id);
-        if ( ! isset($this->_req_data['action'])
-             || ! isset($this->_cpt_routes[$this->_req_data['action']])
-             || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
-        ) {
-            return $link;
-        }
-        $query_args = array(
-            'action' => isset($this->_cpt_edit_routes[$post->post_type])
-                ? $this->_cpt_edit_routes[$post->post_type]
-                : 'edit',
-            'post'   => $id,
-        );
-        return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
-    }
-
-
-    /**
-     * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
-     * our routes.
-     *
-     * @param  string $delete_link  original delete link
-     * @param  int    $post_id      id of cpt object
-     * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
-     * @return string new delete link
-     * @throws EE_Error
-     */
-    public function modify_delete_post_link($delete_link, $post_id, $force_delete)
-    {
-        $post = get_post($post_id);
-
-        if (empty($this->_req_data['action'])
-            || ! isset($this->_cpt_routes[$this->_req_data['action']])
-            || ! $post instanceof WP_Post
-            || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
-        ) {
-            return $delete_link;
-        }
-        $this->_set_model_object($post->ID, true);
-
-        //returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
-
-        return EE_Admin_Page::add_query_args_and_nonce(
-            array(
-                'page' => $this->_req_data['page'],
-                'action' => $action,
-                $this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name()
-                    => $post->ID
-            ),
-            admin_url()
-        );
-    }
-
-
-
-    /**
-     * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
-     * so that we can hijack the default redirect locations for wp custom post types
-     * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
-     *
-     * @param  string $location This is the incoming currently set redirect location
-     * @param  string $post_id  This is the 'ID' value of the wp_posts table
-     * @return string           the new location to redirect to
-     */
-    public function cpt_post_location_redirect($location, $post_id)
-    {
-        //we DO have a match so let's setup the url
-        //we have to get the post to determine our route
-        $post       = get_post($post_id);
-        $edit_route = $this->_cpt_edit_routes[$post->post_type];
-        //shared query_args
-        $query_args = array('action' => $edit_route, 'post' => $post_id);
-        $admin_url  = $this->_admin_base_url;
-        if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
-            $status = get_post_status($post_id);
-            if (isset($this->_req_data['publish'])) {
-                switch ($status) {
-                    case 'pending':
-                        $message = 8;
-                        break;
-                    case 'future':
-                        $message = 9;
-                        break;
-                    default:
-                        $message = 6;
-                }
-            } else {
-                $message = 'draft' === $status ? 10 : 1;
-            }
-        } else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
-            $message = 2;
-            //			$append = '#postcustom';
-        } else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
-            $message = 3;
-            //			$append = '#postcustom';
-        } elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') {
-            $message = 7;
-        } else {
-            $message = 4;
-        }
-        //change the message if the post type is not viewable on the frontend
-        $this->_cpt_object = get_post_type_object($post->post_type);
-        $message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
-        $query_args = array_merge(array('message' => $message), $query_args);
-        $this->_process_notices($query_args, true);
-        return self::add_query_args_and_nonce($query_args, $admin_url);
-    }
-
-
-
-    /**
-     * This method is called to inject nav tabs on core WP cpt pages
-     *
-     * @access public
-     * @return void
-     */
-    public function inject_nav_tabs()
-    {
-        //can we hijack and insert the nav_tabs?
-        $nav_tabs = $this->_get_main_nav_tabs();
-        //first close off existing form tag
-        $html = '>';
-        $html .= $nav_tabs;
-        //now let's handle the remaining tag ( missing ">" is CORRECT )
-        $html .= '<span></span';
-        echo $html;
-    }
-
-
-
-    /**
-     * This just sets up the post update messages when an update form is loaded
-     *
-     * @access public
-     * @param  array $messages the original messages array
-     * @return array           the new messages array
-     */
-    public function post_update_messages($messages)
-    {
-        global $post;
-        $id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $id = empty($id) && is_object($post) ? $post->ID : null;
-        //		$post_type = $post ? $post->post_type : false;
-        /*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
+	}
+
+
+
+	/**
+	 * This allows child classes to modify the default editor title that appears when people add a new or edit an
+	 * existing CPT item.     * This uses the _labels property set by the child class via _define_page_props. Just make
+	 * sure you have a key in _labels property that equals 'editor_title' and the value can be whatever you want the
+	 * default to be.
+	 *
+	 * @param string $title The new title (or existing if there is no editor_title defined)
+	 * @return string
+	 */
+	public function add_custom_editor_default_title($title)
+	{
+		return isset($this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]])
+			? $this->_labels['editor_title'][$this->_cpt_routes[$this->_req_action]]
+			: $title;
+	}
+
+
+
+	/**
+	 * hooks into the wp_get_shortlink button and makes sure that the shortlink gets generated
+	 *
+	 * @param string $shortlink   The already generated shortlink
+	 * @param int    $id          Post ID for this item
+	 * @param string $context     The context for the link
+	 * @param bool   $allow_slugs Whether to allow post slugs in the shortlink.
+	 * @return string
+	 */
+	public function add_shortlink_button_to_editor($shortlink, $id, $context, $allow_slugs)
+	{
+		if ( ! empty($id) && get_option('permalink_structure') !== '') {
+			$post = get_post($id);
+			if (isset($post->post_type) && $this->page_slug === $post->post_type) {
+				$shortlink = home_url('?p=' . $post->ID);
+			}
+		}
+		return $shortlink;
+	}
+
+
+
+	/**
+	 * overriding the parent route_admin_request method so we DON'T run the route twice on cpt core page loads (it's
+	 * already run in modify_current_screen())
+	 *
+	 * @return void
+	 */
+	public function route_admin_request()
+	{
+		if ($this->_cpt_route) {
+			return;
+		}
+		try {
+			$this->_route_admin_request();
+		} catch (EE_Error $e) {
+			$e->get_error();
+		}
+	}
+
+
+
+	/**
+	 * Add a hidden form input to cpt core pages so that we know to do redirects to our routes on saves
+	 *
+	 * @return void
+	 */
+	public function cpt_post_form_hidden_input()
+	{
+		echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+		//we're also going to add the route value and the current page so we can direct autosave parsing correctly
+		echo '<div id="ee-cpt-hidden-inputs">';
+		echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
+		echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+		echo '</div>';
+	}
+
+
+
+	/**
+	 * This allows us to redirect the location of revision restores when they happen so it goes to our CPT routes.
+	 *
+	 * @param  string $location Original location url
+	 * @param  int    $status   Status for http header
+	 * @return string           new (or original) url to redirect to.
+	 */
+	public function revision_redirect($location, $status)
+	{
+		//get revision
+		$rev_id = isset($this->_req_data['revision']) ? $this->_req_data['revision'] : null;
+		//can't do anything without revision so let's get out if not present
+		if (empty($rev_id)) {
+			return $location;
+		}
+		//get rev_post_data
+		$rev = get_post($rev_id);
+		$admin_url = $this->_admin_base_url;
+		$query_args = array(
+			'action'   => 'edit',
+			'post'     => $rev->post_parent,
+			'revision' => $rev_id,
+			'message'  => 5,
+		);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * Modify the edit post link generated by wp core function so that EE CPTs get setup differently.
+	 *
+	 * @param  string $link    the original generated link
+	 * @param  int    $id      post id
+	 * @param  string $context optional, defaults to display.  How to write the '&'
+	 * @return string          the link
+	 */
+	public function modify_edit_post_link($link, $id, $context)
+	{
+		$post = get_post($id);
+		if ( ! isset($this->_req_data['action'])
+			 || ! isset($this->_cpt_routes[$this->_req_data['action']])
+			 || $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
+		) {
+			return $link;
+		}
+		$query_args = array(
+			'action' => isset($this->_cpt_edit_routes[$post->post_type])
+				? $this->_cpt_edit_routes[$post->post_type]
+				: 'edit',
+			'post'   => $id,
+		);
+		return self::add_query_args_and_nonce($query_args, $this->_admin_base_url);
+	}
+
+
+	/**
+	 * Modify the trash link on our cpt edit pages so it has the required query var for triggering redirect properly on
+	 * our routes.
+	 *
+	 * @param  string $delete_link  original delete link
+	 * @param  int    $post_id      id of cpt object
+	 * @param  bool   $force_delete whether this is forcing a hard delete instead of trash
+	 * @return string new delete link
+	 * @throws EE_Error
+	 */
+	public function modify_delete_post_link($delete_link, $post_id, $force_delete)
+	{
+		$post = get_post($post_id);
+
+		if (empty($this->_req_data['action'])
+			|| ! isset($this->_cpt_routes[$this->_req_data['action']])
+			|| ! $post instanceof WP_Post
+			|| $post->post_type !== $this->_cpt_routes[$this->_req_data['action']]
+		) {
+			return $delete_link;
+		}
+		$this->_set_model_object($post->ID, true);
+
+		//returns something like `trash_event` or `trash_attendee` or `trash_venue`
+		$action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+
+		return EE_Admin_Page::add_query_args_and_nonce(
+			array(
+				'page' => $this->_req_data['page'],
+				'action' => $action,
+				$this->_cpt_model_obj->get_model()->get_primary_key_field()->get_name()
+					=> $post->ID
+			),
+			admin_url()
+		);
+	}
+
+
+
+	/**
+	 * This is the callback for the 'redirect_post_location' filter in wp-admin/post.php
+	 * so that we can hijack the default redirect locations for wp custom post types
+	 * that WE'RE using and send back to OUR routes.  This should only be hooked in on the right route.
+	 *
+	 * @param  string $location This is the incoming currently set redirect location
+	 * @param  string $post_id  This is the 'ID' value of the wp_posts table
+	 * @return string           the new location to redirect to
+	 */
+	public function cpt_post_location_redirect($location, $post_id)
+	{
+		//we DO have a match so let's setup the url
+		//we have to get the post to determine our route
+		$post       = get_post($post_id);
+		$edit_route = $this->_cpt_edit_routes[$post->post_type];
+		//shared query_args
+		$query_args = array('action' => $edit_route, 'post' => $post_id);
+		$admin_url  = $this->_admin_base_url;
+		if (isset($this->_req_data['save']) || isset($this->_req_data['publish'])) {
+			$status = get_post_status($post_id);
+			if (isset($this->_req_data['publish'])) {
+				switch ($status) {
+					case 'pending':
+						$message = 8;
+						break;
+					case 'future':
+						$message = 9;
+						break;
+					default:
+						$message = 6;
+				}
+			} else {
+				$message = 'draft' === $status ? 10 : 1;
+			}
+		} else if (isset($this->_req_data['addmeta']) && $this->_req_data['addmeta']) {
+			$message = 2;
+			//			$append = '#postcustom';
+		} else if (isset($this->_req_data['deletemeta']) && $this->_req_data['deletemeta']) {
+			$message = 3;
+			//			$append = '#postcustom';
+		} elseif ($this->_req_data['action'] === 'post-quickpress-save-cont') {
+			$message = 7;
+		} else {
+			$message = 4;
+		}
+		//change the message if the post type is not viewable on the frontend
+		$this->_cpt_object = get_post_type_object($post->post_type);
+		$message           = $message === 1 && ! $this->_cpt_object->publicly_queryable ? 4 : $message;
+		$query_args = array_merge(array('message' => $message), $query_args);
+		$this->_process_notices($query_args, true);
+		return self::add_query_args_and_nonce($query_args, $admin_url);
+	}
+
+
+
+	/**
+	 * This method is called to inject nav tabs on core WP cpt pages
+	 *
+	 * @access public
+	 * @return void
+	 */
+	public function inject_nav_tabs()
+	{
+		//can we hijack and insert the nav_tabs?
+		$nav_tabs = $this->_get_main_nav_tabs();
+		//first close off existing form tag
+		$html = '>';
+		$html .= $nav_tabs;
+		//now let's handle the remaining tag ( missing ">" is CORRECT )
+		$html .= '<span></span';
+		echo $html;
+	}
+
+
+
+	/**
+	 * This just sets up the post update messages when an update form is loaded
+	 *
+	 * @access public
+	 * @param  array $messages the original messages array
+	 * @return array           the new messages array
+	 */
+	public function post_update_messages($messages)
+	{
+		global $post;
+		$id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$id = empty($id) && is_object($post) ? $post->ID : null;
+		//		$post_type = $post ? $post->post_type : false;
+		/*$current_route = isset($this->_req_data['current_route']) ? $this->_req_data['current_route'] : 'shouldneverwork';
 
         $route_to_check = $post_type && isset( $this->_cpt_routes[$current_route]) ? $this->_cpt_routes[$current_route] : '';/**/
-        $messages[$post->post_type] = array(
-            0 => '', //Unused. Messages start at index 1.
-            1 => sprintf(
-                __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            2 => __('Custom field updated'),
-            3 => __('Custom field deleted.'),
-            4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
-                : false,
-            6 => sprintf(
-                __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
-                '</a>'
-            ),
-            7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
-            8 => sprintf(
-                __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
-                '</a>'
-            ),
-            9 => sprintf(
-                __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
-                '</a>'
-            ),
-            10 => sprintf(
-                __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
-                '</a>'
-            ),
-        );
-        return $messages;
-    }
-
-
-
-    /**
-     * default method for the 'create_new' route for cpt admin pages.
-     * For reference what to include in here, see wp-admin/post-new.php
-     *
-     * @access  protected
-     * @return void
-     */
-    protected function _create_new_cpt_item()
-    {
-        // gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-        $title            = $post_type_object->labels->add_new_item;
-        $post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        $this->loadEditorTemplate(true);
-    }
-
-
-    /**
-     * Enqueues auto-save and loads the editor template
-     *
-     * @param bool $creating
-     */
-    private function loadEditorTemplate($creating = true) {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        //these vars are used by the template
-        $editing = true;
-        $post_ID = $post->ID;
-        if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
-            //only enqueue autosave when creating event (necessary to get permalink/url generated)
-            //otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
-            if ($creating) {
-                wp_enqueue_script('autosave');
-            } else {
-                if (isset($this->_cpt_routes[$this->_req_data['action']])
-                    && ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
-                ) {
-                    $create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
-                        'create_new', $this);
-                    $post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
-                        'action' => $create_new_action,
-                        'page'   => $this->page_slug,
-                    ), 'admin.php');
-                }
-            }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
-        }
-    }
-
-
-
-    public function add_new_admin_page_global()
-    {
-        $admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
-        ?>
+		$messages[$post->post_type] = array(
+			0 => '', //Unused. Messages start at index 1.
+			1 => sprintf(
+				__('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			2 => __('Custom field updated'),
+			3 => __('Custom field deleted.'),
+			4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+				: false,
+			6 => sprintf(
+				__('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a href="' . esc_url(get_permalink($id)) . '">',
+				'</a>'
+			),
+			7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
+			8 => sprintf(
+				__('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+				'</a>'
+			),
+			9 => sprintf(
+				__('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
+				'<a target="_blank" href="' . esc_url(get_permalink($id)),
+				'</a>'
+			),
+			10 => sprintf(
+				__('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
+				$this->_cpt_object->labels->singular_name,
+				'<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+				'</a>'
+			),
+		);
+		return $messages;
+	}
+
+
+
+	/**
+	 * default method for the 'create_new' route for cpt admin pages.
+	 * For reference what to include in here, see wp-admin/post-new.php
+	 *
+	 * @access  protected
+	 * @return void
+	 */
+	protected function _create_new_cpt_item()
+	{
+		// gather template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+		$title            = $post_type_object->labels->add_new_item;
+		$post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		$this->loadEditorTemplate(true);
+	}
+
+
+	/**
+	 * Enqueues auto-save and loads the editor template
+	 *
+	 * @param bool $creating
+	 */
+	private function loadEditorTemplate($creating = true) {
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		//these vars are used by the template
+		$editing = true;
+		$post_ID = $post->ID;
+		if (apply_filters('FHEE__EE_Admin_Page_CPT___create_new_cpt_item__replace_editor', false, $post) === false) {
+			//only enqueue autosave when creating event (necessary to get permalink/url generated)
+			//otherwise EE doesn't support autosave fully, so to prevent user confusion we disable it in edit context.
+			if ($creating) {
+				wp_enqueue_script('autosave');
+			} else {
+				if (isset($this->_cpt_routes[$this->_req_data['action']])
+					&& ! isset($this->_labels['hide_add_button_on_cpt_route'][$this->_req_data['action']])
+				) {
+					$create_new_action = apply_filters('FHEE__EE_Admin_Page_CPT___edit_cpt_item__create_new_action',
+						'create_new', $this);
+					$post_new_file = EE_Admin_Page::add_query_args_and_nonce(array(
+						'action' => $create_new_action,
+						'page'   => $this->page_slug,
+					), 'admin.php');
+				}
+			}
+			include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+		}
+	}
+
+
+
+	public function add_new_admin_page_global()
+	{
+		$admin_page = ! empty($this->_req_data['post']) ? 'post-php' : 'post-new-php';
+		?>
         <script type="text/javascript">
             adminpage = '<?php echo $admin_page; ?>';
         </script>
         <?php
-    }
-
-
-
-    /**
-     * default method for the 'edit' route for cpt admin pages
-     * For reference on what to put in here, refer to wp-admin/post.php
-     *
-     * @access protected
-     * @return string   template for edit cpt form
-     */
-    protected function _edit_cpt_item()
-    {
-        global $post, $title, $is_IE, $post_type, $post_type_object;
-        $post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
-        $post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
-        if (empty ($post)) {
-            wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
-        }
-        if ( ! empty($_GET['get-post-lock'])) {
-            wp_set_post_lock($post_id);
-            wp_redirect(get_edit_post_link($post_id, 'url'));
-            exit();
-        }
-
-        // template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
-        $post_type        = $this->_cpt_routes[$this->_req_action];
-        $post_type_object = $this->_cpt_object;
-
-        if ( ! wp_check_post_lock($post->ID)) {
-            wp_set_post_lock($post->ID);
-        }
-        add_action('admin_footer', '_admin_notice_post_locked');
-        if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
-            wp_enqueue_script('admin-comments');
-            enqueue_comment_hotkeys_js();
-        }
-        add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
-        //modify the default editor title field with default title.
-        add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
-        $this->loadEditorTemplate(false);
-    }
-
-
-
-    /**
-     * some getters
-     */
-    /**
-     * This returns the protected _cpt_model_obj property
-     *
-     * @return EE_CPT_Base
-     */
-    public function get_cpt_model_obj()
-    {
-        return $this->_cpt_model_obj;
-    }
+	}
+
+
+
+	/**
+	 * default method for the 'edit' route for cpt admin pages
+	 * For reference on what to put in here, refer to wp-admin/post.php
+	 *
+	 * @access protected
+	 * @return string   template for edit cpt form
+	 */
+	protected function _edit_cpt_item()
+	{
+		global $post, $title, $is_IE, $post_type, $post_type_object;
+		$post_id = isset($this->_req_data['post']) ? $this->_req_data['post'] : null;
+		$post = ! empty($post_id) ? get_post($post_id, OBJECT, 'edit') : null;
+		if (empty ($post)) {
+			wp_die(__('You attempted to edit an item that doesn&#8217;t exist. Perhaps it was deleted?'));
+		}
+		if ( ! empty($_GET['get-post-lock'])) {
+			wp_set_post_lock($post_id);
+			wp_redirect(get_edit_post_link($post_id, 'url'));
+			exit();
+		}
+
+		// template vars for WP_ADMIN_PATH . 'edit-form-advanced.php'
+		$post_type        = $this->_cpt_routes[$this->_req_action];
+		$post_type_object = $this->_cpt_object;
+
+		if ( ! wp_check_post_lock($post->ID)) {
+			wp_set_post_lock($post->ID);
+		}
+		add_action('admin_footer', '_admin_notice_post_locked');
+		if (post_type_supports($this->_cpt_routes[$this->_req_action], 'comments')) {
+			wp_enqueue_script('admin-comments');
+			enqueue_comment_hotkeys_js();
+		}
+		add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
+		//modify the default editor title field with default title.
+		add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
+		$this->loadEditorTemplate(false);
+	}
+
+
+
+	/**
+	 * some getters
+	 */
+	/**
+	 * This returns the protected _cpt_model_obj property
+	 *
+	 * @return EE_CPT_Base
+	 */
+	public function get_cpt_model_obj()
+	{
+		return $this->_cpt_model_obj;
+	}
 
 }

Spacing +25 added lines, -25 removed lines

@@ -235,7 +235,7 @@ 
      */
     protected function _register_autosave_containers($ids)
     {
-        $this->_autosave_containers = array_merge($this->_autosave_fields, (array)$ids);
+        $this->_autosave_containers = array_merge($this->_autosave_fields, (array) $ids);
     }
 
 
@@ -282,7 +282,7 @@ 
         //filter _autosave_containers
         $containers = apply_filters('FHEE__EE_Admin_Page_CPT___load_autosave_scripts_styles__containers',
             $this->_autosave_containers, $this);
-        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__' . get_class($this) . '___load_autosave_scripts_styles__containers',
+        $containers = apply_filters('FHEE__EE_Admin_Page_CPT__'.get_class($this).'___load_autosave_scripts_styles__containers',
             $containers, $this);
 
         wp_localize_script('event_editor_js', 'EE_AUTOSAVE_IDS',
@@ -394,7 +394,7 @@ 
         // This is for any plugins that are doing things properly
         // and hooking into the load page hook for core wp cpt routes.
         global $pagenow;
-        do_action('load-' . $pagenow);
+        do_action('load-'.$pagenow);
         $this->modify_current_screen();
         add_action('admin_enqueue_scripts', array($this, 'setup_autosave_hooks'), 30);
         //we route REALLY early.
@@ -425,8 +425,8 @@ 
                 'admin.php?page=espresso_registrations&action=contact_list',
             ),
             1 => array(
-                'edit.php?post_type=' . $this->_cpt_object->name,
-                'admin.php?page=' . $this->_cpt_object->name,
+                'edit.php?post_type='.$this->_cpt_object->name,
+                'admin.php?page='.$this->_cpt_object->name,
             ),
         );
         foreach ($routes_to_match as $route_matches) {
@@ -454,7 +454,7 @@ 
         $cpt_has_support = ! empty($cpt_args['page_templates']);
 
         //if the installed version of WP is > 4.7 we do some additional checks.
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+        if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
             $post_templates = wp_get_theme()->get_post_templates();
             //if there are $post_templates for this cpt, then we return false for this method because
             //that means we aren't going to load our page template manager and leave that up to the native
@@ -477,7 +477,7 @@ 
         global $post;
         $template = '';
 
-        if (EE_Recommended_Versions::check_wp_version('4.7','>=')) {
+        if (EE_Recommended_Versions::check_wp_version('4.7', '>=')) {
             $page_template_count = count(get_page_templates());
         } else {
             $page_template_count = count(get_page_templates($post));
@@ -514,7 +514,7 @@ 
         $post = get_post($id);
         if ('publish' !== get_post_status($post)) {
             //include shims for the `get_preview_post_link` function
-            require_once( EE_CORE . 'wordpress-shims.php' );
+            require_once(EE_CORE.'wordpress-shims.php');
             $return .= '<span_id="view-post-btn"><a target="_blank" href="'
                        . get_preview_post_link($id)
                        . '" class="button button-small">'
@@ -552,7 +552,7 @@ 
             $template_args['statuses']         = $statuses;
         }
 
-        $template = EE_ADMIN_TEMPLATE . 'status_dropdown.template.php';
+        $template = EE_ADMIN_TEMPLATE.'status_dropdown.template.php';
         EEH_Template::display_template($template, $template_args);
     }
 
@@ -606,7 +606,7 @@ 
             $this->_template_args['success'] = true;
         }
         do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__global_after', $this);
-        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_' . get_class($this), $this);
+        do_action('AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_'.get_class($this), $this);
         //now let's return json
         $this->_return_json();
     }
@@ -1009,7 +1009,7 @@ 
         //global action
         do_action('AHEE_EE_Admin_Page_CPT__restore_revision', $post_id, $revision_id);
         //class specific action so you can limit hooking into a specific page.
-        do_action('AHEE_EE_Admin_Page_CPT_' . get_class($this) . '__restore_revision', $post_id, $revision_id);
+        do_action('AHEE_EE_Admin_Page_CPT_'.get_class($this).'__restore_revision', $post_id, $revision_id);
     }
 
 
@@ -1087,7 +1087,7 @@ 
         if ( ! empty($id) && get_option('permalink_structure') !== '') {
             $post = get_post($id);
             if (isset($post->post_type) && $this->page_slug === $post->post_type) {
-                $shortlink = home_url('?p=' . $post->ID);
+                $shortlink = home_url('?p='.$post->ID);
             }
         }
         return $shortlink;
@@ -1122,11 +1122,11 @@ 
      */
     public function cpt_post_form_hidden_input()
     {
-        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="' . $this->_admin_base_url . '" />';
+        echo '<input type="hidden" name="ee_cpt_item_redirect_url" value="'.$this->_admin_base_url.'" />';
         //we're also going to add the route value and the current page so we can direct autosave parsing correctly
         echo '<div id="ee-cpt-hidden-inputs">';
-        echo '<input type="hidden" id="current_route" name="current_route" value="' . $this->_current_view . '" />';
-        echo '<input type="hidden" id="current_page" name="current_page" value="' . $this->page_slug . '" />';
+        echo '<input type="hidden" id="current_route" name="current_route" value="'.$this->_current_view.'" />';
+        echo '<input type="hidden" id="current_page" name="current_page" value="'.$this->page_slug.'" />';
         echo '</div>';
     }
 
@@ -1213,7 +1213,7 @@ 
         $this->_set_model_object($post->ID, true);
 
         //returns something like `trash_event` or `trash_attendee` or `trash_venue`
-        $action = 'trash_' . str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
+        $action = 'trash_'.str_replace('ee_', '', strtolower(get_class($this->_cpt_model_obj)));
 
         return EE_Admin_Page::add_query_args_and_nonce(
             array(
@@ -1324,39 +1324,39 @@ 
             1 => sprintf(
                 __('%1$s updated. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             2 => __('Custom field updated'),
             3 => __('Custom field deleted.'),
             4 => sprintf(__('%1$s updated.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             5 => isset($_GET['revision']) ? sprintf(__('%s restored to revision from %s', 'event_espresso'),
-                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int)$_GET['revision'], false))
+                $this->_cpt_object->labels->singular_name, wp_post_revision_title((int) $_GET['revision'], false))
                 : false,
             6 => sprintf(
                 __('%1$s published. %2$sView %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a href="' . esc_url(get_permalink($id)) . '">',
+                '<a href="'.esc_url(get_permalink($id)).'">',
                 '</a>'
             ),
             7 => sprintf(__('%1$s saved.', 'event_espresso'), $this->_cpt_object->labels->singular_name),
             8 => sprintf(
                 __('%1$s submitted. %2$sPreview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))) . '">',
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))).'">',
                 '</a>'
             ),
             9 => sprintf(
                 __('%1$s scheduled for: %2$s. %3$s">Preview %1$s%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<strong>' . date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)) . '</strong>',
-                '<a target="_blank" href="' . esc_url(get_permalink($id)),
+                '<strong>'.date_i18n(__('M j, Y @ G:i'), strtotime($post->post_date)).'</strong>',
+                '<a target="_blank" href="'.esc_url(get_permalink($id)),
                 '</a>'
             ),
             10 => sprintf(
                 __('%1$s draft updated. %2$s">Preview page%3$s', 'event_espresso'),
                 $this->_cpt_object->labels->singular_name,
-                '<a target="_blank" href="' . esc_url(add_query_arg('preview', 'true', get_permalink($id))),
+                '<a target="_blank" href="'.esc_url(add_query_arg('preview', 'true', get_permalink($id))),
                 '</a>'
             ),
         );
@@ -1379,7 +1379,7 @@ 
         $post_type        = $this->_cpt_routes[$this->_req_action];
         $post_type_object = $this->_cpt_object;
         $title            = $post_type_object->labels->add_new_item;
-        $post    = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
+        $post = $post = get_default_post_to_edit($this->_cpt_routes[$this->_req_action], true);
         add_action('admin_print_styles', array($this, 'add_new_admin_page_global'));
         //modify the default editor title field with default title.
         add_filter('enter_title_here', array($this, 'add_custom_editor_default_title'), 10);
@@ -1414,7 +1414,7 @@ 
                     ), 'admin.php');
                 }
             }
-            include_once WP_ADMIN_PATH . 'edit-form-advanced.php';
+            include_once WP_ADMIN_PATH.'edit-form-advanced.php';
         }
     }
 

core/libraries/plugin_api/EE_Register_Data_Migration_Scripts.lib.php

Indentation +79 added lines, -79 removed lines

@@ -18,91 +18,91 @@
 class EE_Register_Data_Migration_Scripts implements EEI_Plugin_API
 {
 
-    /**
-     * Holds values for registered DMSs
-     *
-     * @var array
-     */
-    protected static $_settings = array();
+	/**
+	 * Holds values for registered DMSs
+	 *
+	 * @var array
+	 */
+	protected static $_settings = array();
 
 
-    /**
-     * Method for registering new Data Migration Scripts
-     *
-     * @since 4.3.0
-     * @param string $dms_id a unique identifier for this set of data migration scripts
-     * @param array $setup_args {
-     *      @type string  $dms_paths an array of full server paths to folders that contain data migration scripts
-     *  }
-     * @throws EE_Error
-     * @return void
-     */
-    public static function register($dms_id = null, $setup_args = array())
-    {
-        //required fields MUST be present, so let's make sure they are.
-        if (empty($dms_id) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
-            throw new EE_Error(
-                __(
-                    'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include a "dms_id" (a unique identifier for this set of data migration scripts), and  an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
-                    'event_espresso'
-                )
-            );
-        }
-        //make sure we don't register twice
-        if (isset(self::$_settings[ $dms_id ])) {
-            return;
-        }
-        //make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
-            || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
-        ) {
-            EE_Error::doing_it_wrong(
-                __METHOD__,
-                __(
-                    'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
-                    'event_espresso'
-                ),
-                '4.3.0'
-            );
-        }
-        //setup $_settings array from incoming values.
-        self::$_settings[ $dms_id ] = array(
-            'dms_paths' => isset($setup_args['dms_paths']) ? (array) $setup_args['dms_paths'] : array(),
-        );
-        // setup DMS
-        add_filter(
-            'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
-            array('EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders')
-        );
-    }
+	/**
+	 * Method for registering new Data Migration Scripts
+	 *
+	 * @since 4.3.0
+	 * @param string $dms_id a unique identifier for this set of data migration scripts
+	 * @param array $setup_args {
+	 *      @type string  $dms_paths an array of full server paths to folders that contain data migration scripts
+	 *  }
+	 * @throws EE_Error
+	 * @return void
+	 */
+	public static function register($dms_id = null, $setup_args = array())
+	{
+		//required fields MUST be present, so let's make sure they are.
+		if (empty($dms_id) || ! is_array($setup_args) || empty($setup_args['dms_paths'])) {
+			throw new EE_Error(
+				__(
+					'In order to register Data Migration Scripts with EE_Register_Data_Migration_Scripts::register(), you must include a "dms_id" (a unique identifier for this set of data migration scripts), and  an array containing the following keys: "dms_paths" (an array of full server paths to folders that contain data migration scripts)',
+					'event_espresso'
+				)
+			);
+		}
+		//make sure we don't register twice
+		if (isset(self::$_settings[ $dms_id ])) {
+			return;
+		}
+		//make sure this was called in the right place!
+		if (! did_action('AHEE__EE_System__load_espresso_addons')
+			|| did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
+		) {
+			EE_Error::doing_it_wrong(
+				__METHOD__,
+				__(
+					'An attempt to register Data Migration Scripts has failed because it was not registered at the correct time.  Please use the "AHEE__EE_System__load_espresso_addons" hook to register Data Migration Scripts.',
+					'event_espresso'
+				),
+				'4.3.0'
+			);
+		}
+		//setup $_settings array from incoming values.
+		self::$_settings[ $dms_id ] = array(
+			'dms_paths' => isset($setup_args['dms_paths']) ? (array) $setup_args['dms_paths'] : array(),
+		);
+		// setup DMS
+		add_filter(
+			'FHEE__EE_Data_Migration_Manager__get_data_migration_script_folders',
+			array('EE_Register_Data_Migration_Scripts', 'add_data_migration_script_folders')
+		);
+	}
 
 
-    /**
-     * @param array $dms_paths
-     * @return array
-     */
-    public static function add_data_migration_script_folders($dms_paths = array())
-    {
-        foreach (self::$_settings as $settings) {
-            $dms_paths = array_merge($dms_paths, $settings['dms_paths']);
-        }
-        return $dms_paths;
-    }
+	/**
+	 * @param array $dms_paths
+	 * @return array
+	 */
+	public static function add_data_migration_script_folders($dms_paths = array())
+	{
+		foreach (self::$_settings as $settings) {
+			$dms_paths = array_merge($dms_paths, $settings['dms_paths']);
+		}
+		return $dms_paths;
+	}
 
 
-    /**
-     * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
-     *
-     * @since 4.3.0
-     * @param mixed $dms_id unique identifier for the set of Data Migration Scripts that were previously registered
-     * @return void
-     */
-    public static function deregister($dms_id = null)
-    {
-        if (isset(self::$_settings[ $dms_id ])) {
-            unset(self::$_settings[ $dms_id ]);
-        }
-    }
+	/**
+	 * This deregisters a set of Data Migration Scripts that were previously registered with a specific dms_id
+	 *
+	 * @since 4.3.0
+	 * @param mixed $dms_id unique identifier for the set of Data Migration Scripts that were previously registered
+	 * @return void
+	 */
+	public static function deregister($dms_id = null)
+	{
+		if (isset(self::$_settings[ $dms_id ])) {
+			unset(self::$_settings[ $dms_id ]);
+		}
+	}
 }
 // End of file EE_Register_Data_Migration_Scripts.lib.php
 // Location: /core/libraries/plugin_api/EE_Register_Data_Migration_Scripts.lib.php

Spacing +5 added lines, -5 removed lines

@@ -49,11 +49,11 @@ 
             );
         }
         //make sure we don't register twice
-        if (isset(self::$_settings[ $dms_id ])) {
+        if (isset(self::$_settings[$dms_id])) {
             return;
         }
         //make sure this was called in the right place!
-        if (! did_action('AHEE__EE_System__load_espresso_addons')
+        if ( ! did_action('AHEE__EE_System__load_espresso_addons')
             || did_action('AHEE__EE_System___detect_if_activation_or_upgrade__begin')
         ) {
             EE_Error::doing_it_wrong(
@@ -66,7 +66,7 @@ 
             );
         }
         //setup $_settings array from incoming values.
-        self::$_settings[ $dms_id ] = array(
+        self::$_settings[$dms_id] = array(
             'dms_paths' => isset($setup_args['dms_paths']) ? (array) $setup_args['dms_paths'] : array(),
         );
         // setup DMS
@@ -99,8 +99,8 @@ 
      */
     public static function deregister($dms_id = null)
     {
-        if (isset(self::$_settings[ $dms_id ])) {
-            unset(self::$_settings[ $dms_id ]);
+        if (isset(self::$_settings[$dms_id])) {
+            unset(self::$_settings[$dms_id]);
         }
     }
 }

caffeinated/admin/new/pricing/espresso_events_Pricing_Hooks.class.php

Doc Comments +12 added lines, -12 removed lines

@@ -1163,8 +1163,8 @@ 
      * @param array       $datetime_tickets
      * @param array       $all_tickets
      * @param bool        $default
-     * @param array       $all_datetimes
-     * @return mixed
+     * @param EE_Datetime[]       $all_datetimes
+     * @return string
      * @throws DomainException
      * @throws EE_Error
      */
@@ -1275,7 +1275,7 @@ 
      * @param array       $datetime_tickets
      * @param array       $all_tickets
      * @param bool        $default
-     * @return mixed
+     * @return string
      * @throws DomainException
      * @throws EE_Error
      */
@@ -1343,7 +1343,7 @@ 
      * @param EE_Ticket   $ticket
      * @param array       $datetime_tickets
      * @param bool        $default
-     * @return mixed
+     * @return string
      * @throws DomainException
      * @throws EE_Error
      */
@@ -1413,7 +1413,7 @@ 
      * @param bool          $default          Whether default row being generated or not.
      * @param EE_Ticket[]   $all_tickets      This is an array of all tickets attached to the event
      *                                        (or empty in the case of defaults)
-     * @return mixed
+     * @return string
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException
@@ -1737,7 +1737,7 @@ 
      * @param EE_Ticket|null $ticket
      * @param bool           $show_trash
      * @param bool           $show_create
-     * @return mixed
+     * @return string
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
      * @throws InvalidDataTypeException
@@ -1840,7 +1840,7 @@ 
      * @param EE_Price $price
      * @param bool     $default
      * @param bool     $disabled
-     * @return mixed
+     * @return string
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -1873,7 +1873,7 @@ 
      * @param int      $price_row
      * @param EE_Price $price
      * @param bool     $default
-     * @return mixed
+     * @return string
      * @throws DomainException
      * @throws EE_Error
      */
@@ -1910,7 +1910,7 @@ 
      * @param EE_Price $price
      * @param bool     $default
      * @param bool     $disabled
-     * @return mixed
+     * @return string
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -2012,7 +2012,7 @@ 
      * @param EE_Ticket|null   $ticket
      * @param array            $ticket_datetimes
      * @param bool             $default
-     * @return mixed
+     * @return string
      * @throws DomainException
      * @throws EE_Error
      */
@@ -2065,9 +2065,9 @@ 
 
 
     /**
-     * @param array $all_datetimes
+     * @param EE_Datetime[] $all_datetimes
      * @param array $all_tickets
-     * @return mixed
+     * @return string
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException

Indentation +2130 added lines, -2130 removed lines

@@ -19,2190 +19,2190 @@
 class espresso_events_Pricing_Hooks extends EE_Admin_Hooks
 {
 
-    /**
-     * This property is just used to hold the status of whether an event is currently being
-     * created (true) or edited (false)
-     *
-     * @access protected
-     * @var bool
-     */
-    protected $_is_creating_event;
+	/**
+	 * This property is just used to hold the status of whether an event is currently being
+	 * created (true) or edited (false)
+	 *
+	 * @access protected
+	 * @var bool
+	 */
+	protected $_is_creating_event;
 
-    /**
-     * Used to contain the format strings for date and time that will be used for php date and
-     * time.
-     * Is set in the _set_hooks_properties() method.
-     *
-     * @var array
-     */
-    protected $_date_format_strings;
+	/**
+	 * Used to contain the format strings for date and time that will be used for php date and
+	 * time.
+	 * Is set in the _set_hooks_properties() method.
+	 *
+	 * @var array
+	 */
+	protected $_date_format_strings;
 
-    /**
-     * @var string $_date_time_format
-     */
-    protected $_date_time_format;
+	/**
+	 * @var string $_date_time_format
+	 */
+	protected $_date_time_format;
 
 
-    /**
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     */
-    protected function _set_hooks_properties()
-    {
-        $this->_name = 'pricing';
-        //capability check
-        if (! EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_default_prices',
-            'advanced_ticket_datetime_metabox'
-        )) {
-            return;
-        }
-        $this->_setup_metaboxes();
-        $this->_set_date_time_formats();
-        $this->_validate_format_strings();
-        $this->_set_scripts_styles();
-        // commented out temporarily until logic is implemented in callback
-        // add_action(
-        //     'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
-        //     array($this, 'autosave_handling')
-        // );
-        add_filter(
-            'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
-            array($this, 'caf_updates')
-        );
-    }
+	/**
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 */
+	protected function _set_hooks_properties()
+	{
+		$this->_name = 'pricing';
+		//capability check
+		if (! EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_default_prices',
+			'advanced_ticket_datetime_metabox'
+		)) {
+			return;
+		}
+		$this->_setup_metaboxes();
+		$this->_set_date_time_formats();
+		$this->_validate_format_strings();
+		$this->_set_scripts_styles();
+		// commented out temporarily until logic is implemented in callback
+		// add_action(
+		//     'AHEE__EE_Admin_Page_CPT__do_extra_autosave_stuff__after_Extend_Events_Admin_Page',
+		//     array($this, 'autosave_handling')
+		// );
+		add_filter(
+			'FHEE__Events_Admin_Page___insert_update_cpt_item__event_update_callbacks',
+			array($this, 'caf_updates')
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    protected function _setup_metaboxes()
-    {
-        //if we were going to add our own metaboxes we'd use the below.
-        $this->_metaboxes        = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'func'       => 'pricing_metabox',
-                'label'      => esc_html__('Event Tickets & Datetimes', 'event_espresso'),
-                'priority'   => 'high',
-                'context'    => 'normal',
-            ),
-        );
-        $this->_remove_metaboxes = array(
-            0 => array(
-                'page_route' => array('edit', 'create_new'),
-                'id'         => 'espresso_event_editor_tickets',
-                'context'    => 'normal',
-            ),
-        );
-    }
+	/**
+	 * @return void
+	 */
+	protected function _setup_metaboxes()
+	{
+		//if we were going to add our own metaboxes we'd use the below.
+		$this->_metaboxes        = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'func'       => 'pricing_metabox',
+				'label'      => esc_html__('Event Tickets & Datetimes', 'event_espresso'),
+				'priority'   => 'high',
+				'context'    => 'normal',
+			),
+		);
+		$this->_remove_metaboxes = array(
+			0 => array(
+				'page_route' => array('edit', 'create_new'),
+				'id'         => 'espresso_event_editor_tickets',
+				'context'    => 'normal',
+			),
+		);
+	}
 
 
-    /**
-     * @return void
-     */
-    protected function _set_date_time_formats()
-    {
-        /**
-         * Format strings for date and time.  Defaults are existing behaviour from 4.1.
-         * Note, that if you return null as the value for 'date', and 'time' in the array, then
-         * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
-         *
-         * @since 4.6.7
-         * @var array  Expected an array returned with 'date' and 'time' keys.
-         */
-        $this->_date_format_strings = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
-            array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a',
-            )
-        );
-        //validate
-        $this->_date_format_strings['date'] = isset($this->_date_format_strings['date'])
-            ? $this->_date_format_strings['date']
-            : null;
-        $this->_date_format_strings['time'] = isset($this->_date_format_strings['time'])
-            ? $this->_date_format_strings['time']
-            : null;
-        $this->_date_time_format            = $this->_date_format_strings['date']
-                                              . ' '
-                                              . $this->_date_format_strings['time'];
-    }
+	/**
+	 * @return void
+	 */
+	protected function _set_date_time_formats()
+	{
+		/**
+		 * Format strings for date and time.  Defaults are existing behaviour from 4.1.
+		 * Note, that if you return null as the value for 'date', and 'time' in the array, then
+		 * EE will automatically use the set wp_options, 'date_format', and 'time_format'.
+		 *
+		 * @since 4.6.7
+		 * @var array  Expected an array returned with 'date' and 'time' keys.
+		 */
+		$this->_date_format_strings = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___set_hooks_properties__date_format_strings',
+			array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a',
+			)
+		);
+		//validate
+		$this->_date_format_strings['date'] = isset($this->_date_format_strings['date'])
+			? $this->_date_format_strings['date']
+			: null;
+		$this->_date_format_strings['time'] = isset($this->_date_format_strings['time'])
+			? $this->_date_format_strings['time']
+			: null;
+		$this->_date_time_format            = $this->_date_format_strings['date']
+											  . ' '
+											  . $this->_date_format_strings['time'];
+	}
 
 
-    /**
-     * @return void
-     */
-    protected function _validate_format_strings()
-    {
-        //validate format strings
-        $format_validation = EEH_DTT_Helper::validate_format_string(
-            $this->_date_time_format
-        );
-        if (is_array($format_validation)) {
-            $msg = '<p>';
-            $msg .= sprintf(
-                esc_html__(
-                    'The format "%s" was likely added via a filter and is invalid for the following reasons:',
-                    'event_espresso'
-                ),
-                $this->_date_time_format
-            );
-            $msg .= '</p><ul>';
-            foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
-            }
-            $msg .= '</ul><p>';
-            $msg .= sprintf(
-                esc_html__(
-                    '%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
-                    'event_espresso'
-                ),
-                '<span style="color:#D54E21;">',
-                '</span>'
-            );
-            $msg .= '</p>';
-            EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
-            $this->_date_format_strings = array(
-                'date' => 'Y-m-d',
-                'time' => 'h:i a',
-            );
-        }
-    }
+	/**
+	 * @return void
+	 */
+	protected function _validate_format_strings()
+	{
+		//validate format strings
+		$format_validation = EEH_DTT_Helper::validate_format_string(
+			$this->_date_time_format
+		);
+		if (is_array($format_validation)) {
+			$msg = '<p>';
+			$msg .= sprintf(
+				esc_html__(
+					'The format "%s" was likely added via a filter and is invalid for the following reasons:',
+					'event_espresso'
+				),
+				$this->_date_time_format
+			);
+			$msg .= '</p><ul>';
+			foreach ($format_validation as $error) {
+				$msg .= '<li>' . $error . '</li>';
+			}
+			$msg .= '</ul><p>';
+			$msg .= sprintf(
+				esc_html__(
+					'%sPlease note that your date and time formats have been reset to "Y-m-d" and "h:i a" respectively.%s',
+					'event_espresso'
+				),
+				'<span style="color:#D54E21;">',
+				'</span>'
+			);
+			$msg .= '</p>';
+			EE_Error::add_attention($msg, __FILE__, __FUNCTION__, __LINE__);
+			$this->_date_format_strings = array(
+				'date' => 'Y-m-d',
+				'time' => 'h:i a',
+			);
+		}
+	}
 
 
-    /**
-     * @return void
-     */
-    protected function _set_scripts_styles()
-    {
-        $this->_scripts_styles = array(
-            'registers'   => array(
-                'ee-tickets-datetimes-css' => array(
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
-                    'type' => 'css',
-                ),
-                'ee-dtt-ticket-metabox'    => array(
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
-                    'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'),
-                ),
-            ),
-            'deregisters' => array(
-                'event-editor-css'       => array('type' => 'css'),
-                'event-datetime-metabox' => array('type' => 'js'),
-            ),
-            'enqueues'    => array(
-                'ee-tickets-datetimes-css' => array('edit', 'create_new'),
-                'ee-dtt-ticket-metabox'    => array('edit', 'create_new'),
-            ),
-            'localize'    => array(
-                'ee-dtt-ticket-metabox' => array(
-                    'DTT_TRASH_BLOCK'       => array(
-                        'main_warning'            => esc_html__(
-                            'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
-                            'event_espresso'
-                        ),
-                        'after_warning'           => esc_html__(
-                            'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
-                            'event_espresso'
-                        ),
-                        'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Cancel', 'event_espresso') . '</button>',
-                        'close_button'            => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Close', 'event_espresso') . '</button>',
-                        'single_warning_from_tkt' => esc_html__(
-                            'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'
-                        ),
-                        'single_warning_from_dtt' => esc_html__(
-                            'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
-                            'event_espresso'
-                        ),
-                        'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Dismiss', 'event_espresso') . '</button>',
-                    ),
-                    'DTT_ERROR_MSG'         => array(
-                        'no_ticket_name' => esc_html__('General Admission', 'event_espresso'),
-                        'dismiss_button' => '<div class="save-cancel-button-container">'
-                                            . '<button class="button-secondary ee-modal-cancel">'
-                                            . esc_html__('Dismiss', 'event_espresso')
-                                            . '</button></div>',
-                    ),
-                    'DTT_OVERSELL_WARNING'  => array(
-                        'datetime_ticket' => esc_html__(
-                            'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
-                            'event_espresso'
-                        ),
-                        'ticket_datetime' => esc_html__(
-                            'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
-                            'event_espresso'
-                        ),
-                    ),
-                    'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats(
-                        $this->_date_format_strings['date'],
-                        $this->_date_format_strings['time']
-                    ),
-                    'DTT_START_OF_WEEK'     => array('dayValue' => (int) get_option('start_of_week')),
-                ),
-            ),
-        );
-    }
+	/**
+	 * @return void
+	 */
+	protected function _set_scripts_styles()
+	{
+		$this->_scripts_styles = array(
+			'registers'   => array(
+				'ee-tickets-datetimes-css' => array(
+					'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+					'type' => 'css',
+				),
+				'ee-dtt-ticket-metabox'    => array(
+					'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+					'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'),
+				),
+			),
+			'deregisters' => array(
+				'event-editor-css'       => array('type' => 'css'),
+				'event-datetime-metabox' => array('type' => 'js'),
+			),
+			'enqueues'    => array(
+				'ee-tickets-datetimes-css' => array('edit', 'create_new'),
+				'ee-dtt-ticket-metabox'    => array('edit', 'create_new'),
+			),
+			'localize'    => array(
+				'ee-dtt-ticket-metabox' => array(
+					'DTT_TRASH_BLOCK'       => array(
+						'main_warning'            => esc_html__(
+							'The Datetime you are attempting to trash is the only datetime selected for the following ticket(s):',
+							'event_espresso'
+						),
+						'after_warning'           => esc_html__(
+							'In order to trash this datetime you must first make sure the above ticket(s) are assigned to other datetimes.',
+							'event_espresso'
+						),
+						'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Cancel', 'event_espresso') . '</button>',
+						'close_button'            => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Close', 'event_espresso') . '</button>',
+						'single_warning_from_tkt' => esc_html__(
+							'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'
+						),
+						'single_warning_from_dtt' => esc_html__(
+							'The ticket you are attempting to unassign from this datetime cannot be unassigned because the datetime is the only remaining datetime for the ticket.  Tickets must always have at least one datetime assigned to them.',
+							'event_espresso'
+						),
+						'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'
+													 . esc_html__('Dismiss', 'event_espresso') . '</button>',
+					),
+					'DTT_ERROR_MSG'         => array(
+						'no_ticket_name' => esc_html__('General Admission', 'event_espresso'),
+						'dismiss_button' => '<div class="save-cancel-button-container">'
+											. '<button class="button-secondary ee-modal-cancel">'
+											. esc_html__('Dismiss', 'event_espresso')
+											. '</button></div>',
+					),
+					'DTT_OVERSELL_WARNING'  => array(
+						'datetime_ticket' => esc_html__(
+							'You cannot add this ticket to this datetime because it has a sold amount that is greater than the amount of spots remaining for this datetime.',
+							'event_espresso'
+						),
+						'ticket_datetime' => esc_html__(
+							'You cannot add this datetime to this ticket because the ticket has a sold amount that is greater than the amount of spots remaining on the datetime.',
+							'event_espresso'
+						),
+					),
+					'DTT_CONVERTED_FORMATS' => EEH_DTT_Helper::convert_php_to_js_and_moment_date_formats(
+						$this->_date_format_strings['date'],
+						$this->_date_format_strings['time']
+					),
+					'DTT_START_OF_WEEK'     => array('dayValue' => (int) get_option('start_of_week')),
+				),
+			),
+		);
+	}
 
 
-    /**
-     * @param array $update_callbacks
-     * @return array
-     */
-    public function caf_updates(array $update_callbacks)
-    {
-        foreach ($update_callbacks as $key => $callback) {
-            if ($callback[1] === '_default_tickets_update') {
-                unset($update_callbacks[ $key ]);
-            }
-        }
-        $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update');
-        return $update_callbacks;
-    }
+	/**
+	 * @param array $update_callbacks
+	 * @return array
+	 */
+	public function caf_updates(array $update_callbacks)
+	{
+		foreach ($update_callbacks as $key => $callback) {
+			if ($callback[1] === '_default_tickets_update') {
+				unset($update_callbacks[ $key ]);
+			}
+		}
+		$update_callbacks[] = array($this, 'datetime_and_tickets_caf_update');
+		return $update_callbacks;
+	}
 
 
-    /**
-     * Handles saving everything related to Tickets (datetimes, tickets, prices)
-     *
-     * @param  EE_Event $event The Event object we're attaching data to
-     * @param  array    $data  The request data from the form
-     * @throws ReflectionException
-     * @throws Exception
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     */
-    public function datetime_and_tickets_caf_update($event, $data)
-    {
-        //first we need to start with datetimes cause they are the "root" items attached to events.
-        $saved_datetimes = $this->_update_datetimes($event, $data);
-        //next tackle the tickets (and prices?)
-        $this->_update_tickets($event, $saved_datetimes, $data);
-    }
+	/**
+	 * Handles saving everything related to Tickets (datetimes, tickets, prices)
+	 *
+	 * @param  EE_Event $event The Event object we're attaching data to
+	 * @param  array    $data  The request data from the form
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 */
+	public function datetime_and_tickets_caf_update($event, $data)
+	{
+		//first we need to start with datetimes cause they are the "root" items attached to events.
+		$saved_datetimes = $this->_update_datetimes($event, $data);
+		//next tackle the tickets (and prices?)
+		$this->_update_tickets($event, $saved_datetimes, $data);
+	}
 
 
-    /**
-     * update event_datetimes
-     *
-     * @param  EE_Event $event Event being updated
-     * @param  array    $data  the request data from the form
-     * @return EE_Datetime[]
-     * @throws Exception
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    protected function _update_datetimes($event, $data)
-    {
-        $timezone       = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_dtt_ids  = array();
-        $saved_dtt_objs = array();
-        if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The "edit_event_datetimes" array is invalid therefore the event can not be updated.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
-            //trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map(
-                function ($datetime_data)
-                {
-                    return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
-                },
-                $datetime_data
-            );
-            $datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end'])
-                                            && ! empty($datetime_data['DTT_EVT_end'])
-                ? $datetime_data['DTT_EVT_end']
-                : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = array(
-                'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
-                    ? $datetime_data['DTT_ID']
-                    : null,
-                'DTT_name'        => ! empty($datetime_data['DTT_name'])
-                    ? $datetime_data['DTT_name']
-                    : '',
-                'DTT_description' => ! empty($datetime_data['DTT_description'])
-                    ? $datetime_data['DTT_description']
-                    : '',
-                'DTT_EVT_start'   => $datetime_data['DTT_EVT_start'],
-                'DTT_EVT_end'     => $datetime_data['DTT_EVT_end'],
-                'DTT_reg_limit'   => empty($datetime_data['DTT_reg_limit'])
-                    ? EE_INF
-                    : $datetime_data['DTT_reg_limit'],
-                'DTT_order'       => ! isset($datetime_data['DTT_order'])
-                    ? $row
-                    : $datetime_data['DTT_order'],
-            );
-            // if we have an id then let's get existing object first and then set the new values.
-            // Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
-                $datetime = EE_Registry::instance()
-                                       ->load_model('Datetime', array($timezone))
-                                       ->get_one_by_ID($datetime_data['DTT_ID']);
-                //set date and time format according to what is set in this class.
-                $datetime->set_date_format($this->_date_format_strings['date']);
-                $datetime->set_time_format($this->_date_format_strings['time']);
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-                // make sure the $dtt_id here is saved just in case
-                // after the add_relation_to() the autosave replaces it.
-                // We need to do this so we dont' TRASH the parent DTT.
-                // (save the ID for both key and value to avoid duplications)
-                $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID();
-            } else {
-                $datetime = EE_Registry::instance()->load_class(
-                    'Datetime',
-                    array(
-                        $datetime_values,
-                        $timezone,
-                        array($this->_date_format_strings['date'], $this->_date_format_strings['time']),
-                    ),
-                    false,
-                    false
-                );
-                foreach ($datetime_values as $field => $value) {
-                    $datetime->set($field, $value);
-                }
-            }
-            $datetime->save();
-            $datetime = $event->_add_relation_to($datetime, 'Datetime');
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
-                $datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
-                $datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
-                $datetime->save();
-            }
-            //	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
-            // because it is possible there was a new one created for the autosave.
-            // (save the ID for both key and value to avoid duplications)
-            $DTT_ID                   = $datetime->ID();
-            $saved_dtt_ids[ $DTT_ID ] = $DTT_ID;
-            $saved_dtt_objs[ $row ]   = $datetime;
-            //todo if ANY of these updates fail then we want the appropriate global error message.
-        }
-        $event->save();
-        // now we need to REMOVE any datetimes that got deleted.
-        // Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them.
-        // So its safe to permanently delete at this point.
-        $old_datetimes = explode(',', $data['datetime_IDs']);
-        $old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes;
-        if (is_array($old_datetimes)) {
-            $datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
-            foreach ($datetimes_to_delete as $id) {
-                $id = absint($id);
-                if (empty($id)) {
-                    continue;
-                }
-                $dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
-                //remove tkt relationships.
-                $related_tickets = $dtt_to_remove->get_many_related('Ticket');
-                foreach ($related_tickets as $tkt) {
-                    $dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
-                }
-                $event->_remove_relation_to($id, 'Datetime');
-                $dtt_to_remove->refresh_cache_of_related_objects();
-            }
-        }
-        return $saved_dtt_objs;
-    }
+	/**
+	 * update event_datetimes
+	 *
+	 * @param  EE_Event $event Event being updated
+	 * @param  array    $data  the request data from the form
+	 * @return EE_Datetime[]
+	 * @throws Exception
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	protected function _update_datetimes($event, $data)
+	{
+		$timezone       = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_dtt_ids  = array();
+		$saved_dtt_objs = array();
+		if (empty($data['edit_event_datetimes']) || ! is_array($data['edit_event_datetimes'])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The "edit_event_datetimes" array is invalid therefore the event can not be updated.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
+			//trim all values to ensure any excess whitespace is removed.
+			$datetime_data                = array_map(
+				function ($datetime_data)
+				{
+					return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
+				},
+				$datetime_data
+			);
+			$datetime_data['DTT_EVT_end'] = isset($datetime_data['DTT_EVT_end'])
+											&& ! empty($datetime_data['DTT_EVT_end'])
+				? $datetime_data['DTT_EVT_end']
+				: $datetime_data['DTT_EVT_start'];
+			$datetime_values              = array(
+				'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
+					? $datetime_data['DTT_ID']
+					: null,
+				'DTT_name'        => ! empty($datetime_data['DTT_name'])
+					? $datetime_data['DTT_name']
+					: '',
+				'DTT_description' => ! empty($datetime_data['DTT_description'])
+					? $datetime_data['DTT_description']
+					: '',
+				'DTT_EVT_start'   => $datetime_data['DTT_EVT_start'],
+				'DTT_EVT_end'     => $datetime_data['DTT_EVT_end'],
+				'DTT_reg_limit'   => empty($datetime_data['DTT_reg_limit'])
+					? EE_INF
+					: $datetime_data['DTT_reg_limit'],
+				'DTT_order'       => ! isset($datetime_data['DTT_order'])
+					? $row
+					: $datetime_data['DTT_order'],
+			);
+			// if we have an id then let's get existing object first and then set the new values.
+			// Otherwise we instantiate a new object for save.
+			if (! empty($datetime_data['DTT_ID'])) {
+				$datetime = EE_Registry::instance()
+									   ->load_model('Datetime', array($timezone))
+									   ->get_one_by_ID($datetime_data['DTT_ID']);
+				//set date and time format according to what is set in this class.
+				$datetime->set_date_format($this->_date_format_strings['date']);
+				$datetime->set_time_format($this->_date_format_strings['time']);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+				// make sure the $dtt_id here is saved just in case
+				// after the add_relation_to() the autosave replaces it.
+				// We need to do this so we dont' TRASH the parent DTT.
+				// (save the ID for both key and value to avoid duplications)
+				$saved_dtt_ids[ $datetime->ID() ] = $datetime->ID();
+			} else {
+				$datetime = EE_Registry::instance()->load_class(
+					'Datetime',
+					array(
+						$datetime_values,
+						$timezone,
+						array($this->_date_format_strings['date'], $this->_date_format_strings['time']),
+					),
+					false,
+					false
+				);
+				foreach ($datetime_values as $field => $value) {
+					$datetime->set($field, $value);
+				}
+			}
+			$datetime->save();
+			$datetime = $event->_add_relation_to($datetime, 'Datetime');
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($datetime->get_raw('DTT_EVT_start') > $datetime->get_raw('DTT_EVT_end')) {
+				$datetime->set('DTT_EVT_end', $datetime->get('DTT_EVT_start'));
+				$datetime = EEH_DTT_Helper::date_time_add($datetime, 'DTT_EVT_end', 'days');
+				$datetime->save();
+			}
+			//	now we have to make sure we add the new DTT_ID to the $saved_dtt_ids array
+			// because it is possible there was a new one created for the autosave.
+			// (save the ID for both key and value to avoid duplications)
+			$DTT_ID                   = $datetime->ID();
+			$saved_dtt_ids[ $DTT_ID ] = $DTT_ID;
+			$saved_dtt_objs[ $row ]   = $datetime;
+			//todo if ANY of these updates fail then we want the appropriate global error message.
+		}
+		$event->save();
+		// now we need to REMOVE any datetimes that got deleted.
+		// Keep in mind that this process will only kick in for datetimes that don't have any DTT_sold on them.
+		// So its safe to permanently delete at this point.
+		$old_datetimes = explode(',', $data['datetime_IDs']);
+		$old_datetimes = $old_datetimes[0] === '' ? array() : $old_datetimes;
+		if (is_array($old_datetimes)) {
+			$datetimes_to_delete = array_diff($old_datetimes, $saved_dtt_ids);
+			foreach ($datetimes_to_delete as $id) {
+				$id = absint($id);
+				if (empty($id)) {
+					continue;
+				}
+				$dtt_to_remove = EE_Registry::instance()->load_model('Datetime')->get_one_by_ID($id);
+				//remove tkt relationships.
+				$related_tickets = $dtt_to_remove->get_many_related('Ticket');
+				foreach ($related_tickets as $tkt) {
+					$dtt_to_remove->_remove_relation_to($tkt, 'Ticket');
+				}
+				$event->_remove_relation_to($id, 'Datetime');
+				$dtt_to_remove->refresh_cache_of_related_objects();
+			}
+		}
+		return $saved_dtt_objs;
+	}
 
 
-    /**
-     * update tickets
-     *
-     * @param  EE_Event      $event           Event object being updated
-     * @param  EE_Datetime[] $saved_datetimes an array of datetime ids being updated
-     * @param  array         $data            incoming request data
-     * @return EE_Ticket[]
-     * @throws Exception
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws InvalidArgumentException
-     * @throws EE_Error
-     */
-    protected function _update_tickets($event, $saved_datetimes, $data)
-    {
-        $new_tkt     = null;
-        $new_default = null;
-        //stripslashes because WP filtered the $_POST ($data) array to add slashes
-        $data          = stripslashes_deep($data);
-        $timezone      = isset($data['timezone_string']) ? $data['timezone_string'] : null;
-        $saved_tickets = $datetimes_on_existing = array();
-        $old_tickets   = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
-        if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) {
-            throw new InvalidArgumentException(
-                esc_html__(
-                    'The "edit_tickets" array is invalid therefore the event can not be updated.',
-                    'event_espresso'
-                )
-            );
-        }
-        foreach ($data['edit_tickets'] as $row => $tkt) {
-            $update_prices = $create_new_TKT = false;
-            // figure out what datetimes were added to the ticket
-            // and what datetimes were removed from the ticket in the session.
-            $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]);
-            $tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][ $row ]);
-            $datetimes_added       = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
-            $datetimes_removed     = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
-            // trim inputs to ensure any excess whitespace is removed.
-            $tkt = array_map(
-                function ($ticket_data)
-                {
-                    return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
-                },
-                $tkt
-            );
-            // note we are doing conversions to floats here instead of allowing EE_Money_Field to handle
-            // because we're doing calculations prior to using the models.
-            // note incoming ['TKT_price'] value is already in standard notation (via js).
-            $ticket_price = isset($tkt['TKT_price'])
-                ? round((float) $tkt['TKT_price'], 3)
-                : 0;
-            //note incoming base price needs converted from localized value.
-            $base_price = isset($tkt['TKT_base_price'])
-                ? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price'])
-                : 0;
-            //if ticket price == 0 and $base_price != 0 then ticket price == base_price
-            $ticket_price  = $ticket_price === 0 && $base_price !== 0
-                ? $base_price
-                : $ticket_price;
-            $base_price_id = isset($tkt['TKT_base_price_ID'])
-                ? $tkt['TKT_base_price_ID']
-                : 0;
-            $price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
-                : array();
-            $now           = null;
-            if (empty($tkt['TKT_start_date'])) {
-                //lets' use now in the set timezone.
-                $now                   = new DateTime('now', new DateTimeZone($event->get_timezone()));
-                $tkt['TKT_start_date'] = $now->format($this->_date_time_format);
-            }
-            if (empty($tkt['TKT_end_date'])) {
-                /**
-                 * set the TKT_end_date to the first datetime attached to the ticket.
-                 */
-                $first_dtt           = $saved_datetimes[ reset($tkt_dtt_rows) ];
-                $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format);
-            }
-            $TKT_values = array(
-                'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
-                'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
-                'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
-                'TKT_description' => ! empty($tkt['TKT_description'])
-                                     && $tkt['TKT_description'] !== esc_html__(
-                    'You can modify this description',
-                    'event_espresso'
-                )
-                    ? $tkt['TKT_description']
-                    : '',
-                'TKT_start_date'  => $tkt['TKT_start_date'],
-                'TKT_end_date'    => $tkt['TKT_end_date'],
-                'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === ''
-                    ? EE_INF
-                    : $tkt['TKT_qty'],
-                'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === ''
-                    ? EE_INF
-                    : $tkt['TKT_uses'],
-                'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
-                'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
-                'TKT_row'         => $row,
-                'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
-                'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
-                'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
-                'TKT_price'       => $ticket_price,
-            );
-            // if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly,
-            // which means in turn that the prices will become new prices as well.
-            if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
-                $TKT_values['TKT_ID']         = 0;
-                $TKT_values['TKT_is_default'] = 0;
-                $update_prices                = true;
-            }
-            // if we have a TKT_ID then we need to get that existing TKT_obj and update it
-            // we actually do our saves ahead of doing any add_relations to
-            // because its entirely possible that this ticket wasn't removed or added to any datetime in the session
-            // but DID have it's items modified.
-            // keep in mind that if the TKT has been sold (and we have changed pricing information),
-            // then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
-            if (absint($TKT_values['TKT_ID'])) {
-                $ticket = EE_Registry::instance()
-                                     ->load_model('Ticket', array($timezone))
-                                     ->get_one_by_ID($tkt['TKT_ID']);
-                if ($ticket instanceof EE_Ticket) {
-                    $ticket = $this->_update_ticket_datetimes(
-                        $ticket,
-                        $saved_datetimes,
-                        $datetimes_added,
-                        $datetimes_removed
-                    );
-                    // are there any registrations using this ticket ?
-                    $tickets_sold = $ticket->count_related(
-                        'Registration',
-                        array(
-                            array(
-                                'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)),
-                            ),
-                        )
-                    );
-                    //set ticket formats
-                    $ticket->set_date_format($this->_date_format_strings['date']);
-                    $ticket->set_time_format($this->_date_format_strings['time']);
-                    // let's just check the total price for the existing ticket
-                    // and determine if it matches the new total price.
-                    // if they are different then we create a new ticket (if tickets sold)
-                    // if they aren't different then we go ahead and modify existing ticket.
-                    $create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted();
-                    //set new values
-                    foreach ($TKT_values as $field => $value) {
-                        if ($field === 'TKT_qty') {
-                            $ticket->set_qty($value);
-                        } else {
-                            $ticket->set($field, $value);
-                        }
-                    }
-                    // if $create_new_TKT is false then we can safely update the existing ticket.
-                    // Otherwise we have to create a new ticket.
-                    if ($create_new_TKT) {
-                        $new_tkt = $this->_duplicate_ticket(
-                            $ticket,
-                            $price_rows,
-                            $ticket_price,
-                            $base_price,
-                            $base_price_id
-                        );
-                    }
-                }
-            } else {
-                // no TKT_id so a new TKT
-                $ticket = EE_Ticket::new_instance(
-                    $TKT_values,
-                    $timezone,
-                    array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
-                );
-                if ($ticket instanceof EE_Ticket) {
-                    // make sure ticket has an ID of setting relations won't work
-                    $ticket->save();
-                    $ticket        = $this->_update_ticket_datetimes(
-                        $ticket,
-                        $saved_datetimes,
-                        $datetimes_added,
-                        $datetimes_removed
-                    );
-                    $update_prices = true;
-                }
-            }
-            //make sure any current values have been saved.
-            //$ticket->save();
-            // before going any further make sure our dates are setup correctly
-            // so that the end date is always equal or greater than the start date.
-            if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
-                $ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
-                $ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
-            }
-            //let's make sure the base price is handled
-            $ticket = ! $create_new_TKT
-                ? $this->_add_prices_to_ticket(
-                    array(),
-                    $ticket,
-                    $update_prices,
-                    $base_price,
-                    $base_price_id
-                )
-                : $ticket;
-            //add/update price_modifiers
-            $ticket = ! $create_new_TKT
-                ? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices)
-                : $ticket;
-            //need to make sue that the TKT_price is accurate after saving the prices.
-            $ticket->ensure_TKT_Price_correct();
-            //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
-            if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
-                $update_prices = true;
-                $new_default   = clone $ticket;
-                $new_default->set('TKT_ID', 0);
-                $new_default->set('TKT_is_default', 1);
-                $new_default->set('TKT_row', 1);
-                $new_default->set('TKT_price', $ticket_price);
-                // remove any dtt relations cause we DON'T want dtt relations attached
-                // (note this is just removing the cached relations in the object)
-                $new_default->_remove_relations('Datetime');
-                //todo we need to add the current attached prices as new prices to the new default ticket.
-                $new_default = $this->_add_prices_to_ticket(
-                    $price_rows,
-                    $new_default,
-                    $update_prices
-                );
-                //don't forget the base price!
-                $new_default = $this->_add_prices_to_ticket(
-                    array(),
-                    $new_default,
-                    $update_prices,
-                    $base_price,
-                    $base_price_id
-                );
-                $new_default->save();
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket',
-                    $new_default,
-                    $row,
-                    $ticket,
-                    $data
-                );
-            }
-            // DO ALL dtt relationships for both current tickets and any archived tickets
-            // for the given dtt that are related to the current ticket.
-            // TODO... not sure exactly how we're going to do this considering we don't know
-            // what current ticket the archived tickets are related to
-            // (and TKT_parent is used for autosaves so that's not a field we can reliably use).
-            //let's assign any tickets that have been setup to the saved_tickets tracker
-            //save existing TKT
-            $ticket->save();
-            if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
-                //save new TKT
-                $new_tkt->save();
-                //add new ticket to array
-                $saved_tickets[ $new_tkt->ID() ] = $new_tkt;
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
-                    $new_tkt,
-                    $row,
-                    $tkt,
-                    $data
-                );
-            } else {
-                //add tkt to saved tkts
-                $saved_tickets[ $ticket->ID() ] = $ticket;
-                do_action(
-                    'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
-                    $ticket,
-                    $row,
-                    $tkt,
-                    $data
-                );
-            }
-        }
-        // now we need to handle tickets actually "deleted permanently".
-        // There are cases where we'd want this to happen
-        // (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
-        // Or a draft event was saved and in the process of editing a ticket is trashed.
-        // No sense in keeping all the related data in the db!
-        $old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets;
-        $tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
-        foreach ($tickets_removed as $id) {
-            $id = absint($id);
-            //get the ticket for this id
-            $tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
-            //if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
-            if ($tkt_to_remove->get('TKT_is_default')) {
-                continue;
-            }
-            // if this tkt has any registrations attached so then we just ARCHIVE
-            // because we don't actually permanently delete these tickets.
-            if ($tkt_to_remove->count_related('Registration') > 0) {
-                $tkt_to_remove->delete();
-                continue;
-            }
-            // need to get all the related datetimes on this ticket and remove from every single one of them
-            // (remember this process can ONLY kick off if there are NO tkts_sold)
-            $datetimes = $tkt_to_remove->get_many_related('Datetime');
-            foreach ($datetimes as $datetime) {
-                $tkt_to_remove->_remove_relation_to($datetime, 'Datetime');
-            }
-            // need to do the same for prices (except these prices can also be deleted because again,
-            // tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
-            $tkt_to_remove->delete_related_permanently('Price');
-            do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
-            // finally let's delete this ticket
-            // (which should not be blocked at this point b/c we've removed all our relationships)
-            $tkt_to_remove->delete_permanently();
-        }
-        return $saved_tickets;
-    }
+	/**
+	 * update tickets
+	 *
+	 * @param  EE_Event      $event           Event object being updated
+	 * @param  EE_Datetime[] $saved_datetimes an array of datetime ids being updated
+	 * @param  array         $data            incoming request data
+	 * @return EE_Ticket[]
+	 * @throws Exception
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidArgumentException
+	 * @throws EE_Error
+	 */
+	protected function _update_tickets($event, $saved_datetimes, $data)
+	{
+		$new_tkt     = null;
+		$new_default = null;
+		//stripslashes because WP filtered the $_POST ($data) array to add slashes
+		$data          = stripslashes_deep($data);
+		$timezone      = isset($data['timezone_string']) ? $data['timezone_string'] : null;
+		$saved_tickets = $datetimes_on_existing = array();
+		$old_tickets   = isset($data['ticket_IDs']) ? explode(',', $data['ticket_IDs']) : array();
+		if (empty($data['edit_tickets']) || ! is_array($data['edit_tickets'])) {
+			throw new InvalidArgumentException(
+				esc_html__(
+					'The "edit_tickets" array is invalid therefore the event can not be updated.',
+					'event_espresso'
+				)
+			);
+		}
+		foreach ($data['edit_tickets'] as $row => $tkt) {
+			$update_prices = $create_new_TKT = false;
+			// figure out what datetimes were added to the ticket
+			// and what datetimes were removed from the ticket in the session.
+			$starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]);
+			$tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][ $row ]);
+			$datetimes_added       = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
+			$datetimes_removed     = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
+			// trim inputs to ensure any excess whitespace is removed.
+			$tkt = array_map(
+				function ($ticket_data)
+				{
+					return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
+				},
+				$tkt
+			);
+			// note we are doing conversions to floats here instead of allowing EE_Money_Field to handle
+			// because we're doing calculations prior to using the models.
+			// note incoming ['TKT_price'] value is already in standard notation (via js).
+			$ticket_price = isset($tkt['TKT_price'])
+				? round((float) $tkt['TKT_price'], 3)
+				: 0;
+			//note incoming base price needs converted from localized value.
+			$base_price = isset($tkt['TKT_base_price'])
+				? EEH_Money::convert_to_float_from_localized_money($tkt['TKT_base_price'])
+				: 0;
+			//if ticket price == 0 and $base_price != 0 then ticket price == base_price
+			$ticket_price  = $ticket_price === 0 && $base_price !== 0
+				? $base_price
+				: $ticket_price;
+			$base_price_id = isset($tkt['TKT_base_price_ID'])
+				? $tkt['TKT_base_price_ID']
+				: 0;
+			$price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ])
+				? $data['edit_prices'][ $row ]
+				: array();
+			$now           = null;
+			if (empty($tkt['TKT_start_date'])) {
+				//lets' use now in the set timezone.
+				$now                   = new DateTime('now', new DateTimeZone($event->get_timezone()));
+				$tkt['TKT_start_date'] = $now->format($this->_date_time_format);
+			}
+			if (empty($tkt['TKT_end_date'])) {
+				/**
+				 * set the TKT_end_date to the first datetime attached to the ticket.
+				 */
+				$first_dtt           = $saved_datetimes[ reset($tkt_dtt_rows) ];
+				$tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format);
+			}
+			$TKT_values = array(
+				'TKT_ID'          => ! empty($tkt['TKT_ID']) ? $tkt['TKT_ID'] : null,
+				'TTM_ID'          => ! empty($tkt['TTM_ID']) ? $tkt['TTM_ID'] : 0,
+				'TKT_name'        => ! empty($tkt['TKT_name']) ? $tkt['TKT_name'] : '',
+				'TKT_description' => ! empty($tkt['TKT_description'])
+									 && $tkt['TKT_description'] !== esc_html__(
+					'You can modify this description',
+					'event_espresso'
+				)
+					? $tkt['TKT_description']
+					: '',
+				'TKT_start_date'  => $tkt['TKT_start_date'],
+				'TKT_end_date'    => $tkt['TKT_end_date'],
+				'TKT_qty'         => ! isset($tkt['TKT_qty']) || $tkt['TKT_qty'] === ''
+					? EE_INF
+					: $tkt['TKT_qty'],
+				'TKT_uses'        => ! isset($tkt['TKT_uses']) || $tkt['TKT_uses'] === ''
+					? EE_INF
+					: $tkt['TKT_uses'],
+				'TKT_min'         => empty($tkt['TKT_min']) ? 0 : $tkt['TKT_min'],
+				'TKT_max'         => empty($tkt['TKT_max']) ? EE_INF : $tkt['TKT_max'],
+				'TKT_row'         => $row,
+				'TKT_order'       => isset($tkt['TKT_order']) ? $tkt['TKT_order'] : 0,
+				'TKT_taxable'     => ! empty($tkt['TKT_taxable']) ? 1 : 0,
+				'TKT_required'    => ! empty($tkt['TKT_required']) ? 1 : 0,
+				'TKT_price'       => $ticket_price,
+			);
+			// if this is a default TKT, then we need to set the TKT_ID to 0 and update accordingly,
+			// which means in turn that the prices will become new prices as well.
+			if (isset($tkt['TKT_is_default']) && $tkt['TKT_is_default']) {
+				$TKT_values['TKT_ID']         = 0;
+				$TKT_values['TKT_is_default'] = 0;
+				$update_prices                = true;
+			}
+			// if we have a TKT_ID then we need to get that existing TKT_obj and update it
+			// we actually do our saves ahead of doing any add_relations to
+			// because its entirely possible that this ticket wasn't removed or added to any datetime in the session
+			// but DID have it's items modified.
+			// keep in mind that if the TKT has been sold (and we have changed pricing information),
+			// then we won't be updating the tkt but instead a new tkt will be created and the old one archived.
+			if (absint($TKT_values['TKT_ID'])) {
+				$ticket = EE_Registry::instance()
+									 ->load_model('Ticket', array($timezone))
+									 ->get_one_by_ID($tkt['TKT_ID']);
+				if ($ticket instanceof EE_Ticket) {
+					$ticket = $this->_update_ticket_datetimes(
+						$ticket,
+						$saved_datetimes,
+						$datetimes_added,
+						$datetimes_removed
+					);
+					// are there any registrations using this ticket ?
+					$tickets_sold = $ticket->count_related(
+						'Registration',
+						array(
+							array(
+								'STS_ID' => array('NOT IN', array(EEM_Registration::status_id_incomplete)),
+							),
+						)
+					);
+					//set ticket formats
+					$ticket->set_date_format($this->_date_format_strings['date']);
+					$ticket->set_time_format($this->_date_format_strings['time']);
+					// let's just check the total price for the existing ticket
+					// and determine if it matches the new total price.
+					// if they are different then we create a new ticket (if tickets sold)
+					// if they aren't different then we go ahead and modify existing ticket.
+					$create_new_TKT = $tickets_sold > 0 && $ticket_price !== $ticket->price() && ! $ticket->deleted();
+					//set new values
+					foreach ($TKT_values as $field => $value) {
+						if ($field === 'TKT_qty') {
+							$ticket->set_qty($value);
+						} else {
+							$ticket->set($field, $value);
+						}
+					}
+					// if $create_new_TKT is false then we can safely update the existing ticket.
+					// Otherwise we have to create a new ticket.
+					if ($create_new_TKT) {
+						$new_tkt = $this->_duplicate_ticket(
+							$ticket,
+							$price_rows,
+							$ticket_price,
+							$base_price,
+							$base_price_id
+						);
+					}
+				}
+			} else {
+				// no TKT_id so a new TKT
+				$ticket = EE_Ticket::new_instance(
+					$TKT_values,
+					$timezone,
+					array($this->_date_format_strings['date'], $this->_date_format_strings['time'])
+				);
+				if ($ticket instanceof EE_Ticket) {
+					// make sure ticket has an ID of setting relations won't work
+					$ticket->save();
+					$ticket        = $this->_update_ticket_datetimes(
+						$ticket,
+						$saved_datetimes,
+						$datetimes_added,
+						$datetimes_removed
+					);
+					$update_prices = true;
+				}
+			}
+			//make sure any current values have been saved.
+			//$ticket->save();
+			// before going any further make sure our dates are setup correctly
+			// so that the end date is always equal or greater than the start date.
+			if ($ticket->get_raw('TKT_start_date') > $ticket->get_raw('TKT_end_date')) {
+				$ticket->set('TKT_end_date', $ticket->get('TKT_start_date'));
+				$ticket = EEH_DTT_Helper::date_time_add($ticket, 'TKT_end_date', 'days');
+			}
+			//let's make sure the base price is handled
+			$ticket = ! $create_new_TKT
+				? $this->_add_prices_to_ticket(
+					array(),
+					$ticket,
+					$update_prices,
+					$base_price,
+					$base_price_id
+				)
+				: $ticket;
+			//add/update price_modifiers
+			$ticket = ! $create_new_TKT
+				? $this->_add_prices_to_ticket($price_rows, $ticket, $update_prices)
+				: $ticket;
+			//need to make sue that the TKT_price is accurate after saving the prices.
+			$ticket->ensure_TKT_Price_correct();
+			//handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
+			if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
+				$update_prices = true;
+				$new_default   = clone $ticket;
+				$new_default->set('TKT_ID', 0);
+				$new_default->set('TKT_is_default', 1);
+				$new_default->set('TKT_row', 1);
+				$new_default->set('TKT_price', $ticket_price);
+				// remove any dtt relations cause we DON'T want dtt relations attached
+				// (note this is just removing the cached relations in the object)
+				$new_default->_remove_relations('Datetime');
+				//todo we need to add the current attached prices as new prices to the new default ticket.
+				$new_default = $this->_add_prices_to_ticket(
+					$price_rows,
+					$new_default,
+					$update_prices
+				);
+				//don't forget the base price!
+				$new_default = $this->_add_prices_to_ticket(
+					array(),
+					$new_default,
+					$update_prices,
+					$base_price,
+					$base_price_id
+				);
+				$new_default->save();
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_default_ticket',
+					$new_default,
+					$row,
+					$ticket,
+					$data
+				);
+			}
+			// DO ALL dtt relationships for both current tickets and any archived tickets
+			// for the given dtt that are related to the current ticket.
+			// TODO... not sure exactly how we're going to do this considering we don't know
+			// what current ticket the archived tickets are related to
+			// (and TKT_parent is used for autosaves so that's not a field we can reliably use).
+			//let's assign any tickets that have been setup to the saved_tickets tracker
+			//save existing TKT
+			$ticket->save();
+			if ($create_new_TKT && $new_tkt instanceof EE_Ticket) {
+				//save new TKT
+				$new_tkt->save();
+				//add new ticket to array
+				$saved_tickets[ $new_tkt->ID() ] = $new_tkt;
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
+					$new_tkt,
+					$row,
+					$tkt,
+					$data
+				);
+			} else {
+				//add tkt to saved tkts
+				$saved_tickets[ $ticket->ID() ] = $ticket;
+				do_action(
+					'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
+					$ticket,
+					$row,
+					$tkt,
+					$data
+				);
+			}
+		}
+		// now we need to handle tickets actually "deleted permanently".
+		// There are cases where we'd want this to happen
+		// (i.e. autosaves are happening and then in between autosaves the user trashes a ticket).
+		// Or a draft event was saved and in the process of editing a ticket is trashed.
+		// No sense in keeping all the related data in the db!
+		$old_tickets     = isset($old_tickets[0]) && $old_tickets[0] === '' ? array() : $old_tickets;
+		$tickets_removed = array_diff($old_tickets, array_keys($saved_tickets));
+		foreach ($tickets_removed as $id) {
+			$id = absint($id);
+			//get the ticket for this id
+			$tkt_to_remove = EE_Registry::instance()->load_model('Ticket')->get_one_by_ID($id);
+			//if this tkt is a default tkt we leave it alone cause it won't be attached to the datetime
+			if ($tkt_to_remove->get('TKT_is_default')) {
+				continue;
+			}
+			// if this tkt has any registrations attached so then we just ARCHIVE
+			// because we don't actually permanently delete these tickets.
+			if ($tkt_to_remove->count_related('Registration') > 0) {
+				$tkt_to_remove->delete();
+				continue;
+			}
+			// need to get all the related datetimes on this ticket and remove from every single one of them
+			// (remember this process can ONLY kick off if there are NO tkts_sold)
+			$datetimes = $tkt_to_remove->get_many_related('Datetime');
+			foreach ($datetimes as $datetime) {
+				$tkt_to_remove->_remove_relation_to($datetime, 'Datetime');
+			}
+			// need to do the same for prices (except these prices can also be deleted because again,
+			// tickets can only be trashed if they don't have any TKTs sold (otherwise they are just archived))
+			$tkt_to_remove->delete_related_permanently('Price');
+			do_action('AHEE__espresso_events_Pricing_Hooks___update_tkts_delete_ticket', $tkt_to_remove);
+			// finally let's delete this ticket
+			// (which should not be blocked at this point b/c we've removed all our relationships)
+			$tkt_to_remove->delete_permanently();
+		}
+		return $saved_tickets;
+	}
 
 
-    /**
-     * @access  protected
-     * @param EE_Ticket      $ticket
-     * @param \EE_Datetime[] $saved_datetimes
-     * @param \EE_Datetime[] $added_datetimes
-     * @param \EE_Datetime[] $removed_datetimes
-     * @return EE_Ticket
-     * @throws EE_Error
-     */
-    protected function _update_ticket_datetimes(
-        EE_Ticket $ticket,
-        $saved_datetimes = array(),
-        $added_datetimes = array(),
-        $removed_datetimes = array()
-    ) {
-        // to start we have to add the ticket to all the datetimes its supposed to be with,
-        // and removing the ticket from datetimes it got removed from.
-        // first let's add datetimes
-        if (! empty($added_datetimes) && is_array($added_datetimes)) {
-            foreach ($added_datetimes as $row_id) {
-                $row_id = (int) $row_id;
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to add that to the DTT sold because this DTT is getting added.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[ $row_id ]->increase_sold($ticket->sold());
-                        $saved_datetimes[ $row_id ]->save();
-                    }
-                }
-            }
-        }
-        // then remove datetimes
-        if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
-            foreach ($removed_datetimes as $row_id) {
-                $row_id = (int) $row_id;
-                // its entirely possible that a datetime got deleted (instead of just removed from relationship.
-                // So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime');
-                    // Is this an existing ticket (has an ID) and does it have any sold?
-                    // If so, then we need to remove it's sold from the DTT_sold.
-                    if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold());
-                        $saved_datetimes[ $row_id ]->save();
-                    }
-                }
-            }
-        }
-        // cap ticket qty by datetime reg limits
-        $ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
-        return $ticket;
-    }
+	/**
+	 * @access  protected
+	 * @param EE_Ticket      $ticket
+	 * @param \EE_Datetime[] $saved_datetimes
+	 * @param \EE_Datetime[] $added_datetimes
+	 * @param \EE_Datetime[] $removed_datetimes
+	 * @return EE_Ticket
+	 * @throws EE_Error
+	 */
+	protected function _update_ticket_datetimes(
+		EE_Ticket $ticket,
+		$saved_datetimes = array(),
+		$added_datetimes = array(),
+		$removed_datetimes = array()
+	) {
+		// to start we have to add the ticket to all the datetimes its supposed to be with,
+		// and removing the ticket from datetimes it got removed from.
+		// first let's add datetimes
+		if (! empty($added_datetimes) && is_array($added_datetimes)) {
+			foreach ($added_datetimes as $row_id) {
+				$row_id = (int) $row_id;
+				if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
+					$ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to add that to the DTT sold because this DTT is getting added.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[ $row_id ]->increase_sold($ticket->sold());
+						$saved_datetimes[ $row_id ]->save();
+					}
+				}
+			}
+		}
+		// then remove datetimes
+		if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
+			foreach ($removed_datetimes as $row_id) {
+				$row_id = (int) $row_id;
+				// its entirely possible that a datetime got deleted (instead of just removed from relationship.
+				// So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
+				if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
+					$ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+					// Is this an existing ticket (has an ID) and does it have any sold?
+					// If so, then we need to remove it's sold from the DTT_sold.
+					if ($ticket->ID() && $ticket->sold() > 0) {
+						$saved_datetimes[ $row_id ]->decrease_sold($ticket->sold());
+						$saved_datetimes[ $row_id ]->save();
+					}
+				}
+			}
+		}
+		// cap ticket qty by datetime reg limits
+		$ticket->set_qty(min($ticket->qty(), $ticket->qty('reg_limit')));
+		return $ticket;
+	}
 
 
-    /**
-     * @access  protected
-     * @param EE_Ticket $ticket
-     * @param array     $price_rows
-     * @param int       $ticket_price
-     * @param int       $base_price
-     * @param int       $base_price_id
-     * @return EE_Ticket
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _duplicate_ticket(
-        EE_Ticket $ticket,
-        $price_rows = array(),
-        $ticket_price = 0,
-        $base_price = 0,
-        $base_price_id = 0
-    ) {
-        // create new ticket that's a copy of the existing
-        // except a new id of course (and not archived)
-        // AND has the new TKT_price associated with it.
-        $new_ticket = clone $ticket;
-        $new_ticket->set('TKT_ID', 0);
-        $new_ticket->set_deleted(0);
-        $new_ticket->set_price($ticket_price);
-        $new_ticket->set_sold(0);
-        // let's get a new ID for this ticket
-        $new_ticket->save();
-        // we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
-        $datetimes_on_existing = $ticket->datetimes();
-        $new_ticket            = $this->_update_ticket_datetimes(
-            $new_ticket,
-            $datetimes_on_existing,
-            array_keys($datetimes_on_existing)
-        );
-        // $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
-        // if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
-        // available.
-        if ($ticket->sold() > 0) {
-            $new_qty = $ticket->qty() - $ticket->sold();
-            $new_ticket->set_qty($new_qty);
-        }
-        //now we update the prices just for this ticket
-        $new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
-        //and we update the base price
-        $new_ticket = $this->_add_prices_to_ticket(
-            array(),
-            $new_ticket,
-            true,
-            $base_price,
-            $base_price_id
-        );
-        return $new_ticket;
-    }
+	/**
+	 * @access  protected
+	 * @param EE_Ticket $ticket
+	 * @param array     $price_rows
+	 * @param int       $ticket_price
+	 * @param int       $base_price
+	 * @param int       $base_price_id
+	 * @return EE_Ticket
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _duplicate_ticket(
+		EE_Ticket $ticket,
+		$price_rows = array(),
+		$ticket_price = 0,
+		$base_price = 0,
+		$base_price_id = 0
+	) {
+		// create new ticket that's a copy of the existing
+		// except a new id of course (and not archived)
+		// AND has the new TKT_price associated with it.
+		$new_ticket = clone $ticket;
+		$new_ticket->set('TKT_ID', 0);
+		$new_ticket->set_deleted(0);
+		$new_ticket->set_price($ticket_price);
+		$new_ticket->set_sold(0);
+		// let's get a new ID for this ticket
+		$new_ticket->save();
+		// we also need to make sure this new ticket gets the same datetime attachments as the archived ticket
+		$datetimes_on_existing = $ticket->datetimes();
+		$new_ticket            = $this->_update_ticket_datetimes(
+			$new_ticket,
+			$datetimes_on_existing,
+			array_keys($datetimes_on_existing)
+		);
+		// $ticket will get archived later b/c we are NOT adding it to the saved_tickets array.
+		// if existing $ticket has sold amount, then we need to adjust the qty for the new TKT to = the remaining
+		// available.
+		if ($ticket->sold() > 0) {
+			$new_qty = $ticket->qty() - $ticket->sold();
+			$new_ticket->set_qty($new_qty);
+		}
+		//now we update the prices just for this ticket
+		$new_ticket = $this->_add_prices_to_ticket($price_rows, $new_ticket, true);
+		//and we update the base price
+		$new_ticket = $this->_add_prices_to_ticket(
+			array(),
+			$new_ticket,
+			true,
+			$base_price,
+			$base_price_id
+		);
+		return $new_ticket;
+	}
 
 
-    /**
-     * This attaches a list of given prices to a ticket.
-     * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
-     * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
-     * price info and prices are automatically "archived" via the ticket.
-     *
-     * @access  private
-     * @param array     $prices        Array of prices from the form.
-     * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
-     * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
-     * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
-     * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
-     * @return EE_Ticket
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _add_prices_to_ticket(
-        $prices = array(),
-        EE_Ticket $ticket,
-        $new_prices = false,
-        $base_price = false,
-        $base_price_id = false
-    ) {
-        // let's just get any current prices that may exist on the given ticket
-        // so we can remove any prices that got trashed in this session.
-        $current_prices_on_ticket = $base_price !== false
-            ? $ticket->base_price(true)
-            : $ticket->price_modifiers();
-        $updated_prices           = array();
-        // if $base_price ! FALSE then updating a base price.
-        if ($base_price !== false) {
-            $prices[1] = array(
-                'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
-                'PRT_ID'     => 1,
-                'PRC_amount' => $base_price,
-                'PRC_name'   => $ticket->get('TKT_name'),
-                'PRC_desc'   => $ticket->get('TKT_description'),
-            );
-        }
-        //possibly need to save tkt
-        if (! $ticket->ID()) {
-            $ticket->save();
-        }
-        foreach ($prices as $row => $prc) {
-            $prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
-            if (empty($prt_id)) {
-                continue;
-            } //prices MUST have a price type id.
-            $PRC_values = array(
-                'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
-                'PRT_ID'         => $prt_id,
-                'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
-                'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
-                'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
-                'PRC_is_default' => false,
-                //make sure we set PRC_is_default to false for all ticket saves from event_editor
-                'PRC_order'      => $row,
-            );
-            if ($new_prices || empty($PRC_values['PRC_ID'])) {
-                $PRC_values['PRC_ID'] = 0;
-                $price                = EE_Registry::instance()->load_class(
-                    'Price',
-                    array($PRC_values),
-                    false,
-                    false
-                );
-            } else {
-                $price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
-                //update this price with new values
-                foreach ($PRC_values as $field => $value) {
-                    $price->set($field, $value);
-                }
-            }
-            $price->save();
-            $updated_prices[ $price->ID() ] = $price;
-            $ticket->_add_relation_to($price, 'Price');
-        }
-        //now let's remove any prices that got removed from the ticket
-        if (! empty ($current_prices_on_ticket)) {
-            $current          = array_keys($current_prices_on_ticket);
-            $updated          = array_keys($updated_prices);
-            $prices_to_remove = array_diff($current, $updated);
-            if (! empty($prices_to_remove)) {
-                foreach ($prices_to_remove as $prc_id) {
-                    $p = $current_prices_on_ticket[ $prc_id ];
-                    $ticket->_remove_relation_to($p, 'Price');
-                    //delete permanently the price
-                    $p->delete_permanently();
-                }
-            }
-        }
-        return $ticket;
-    }
+	/**
+	 * This attaches a list of given prices to a ticket.
+	 * Note we dont' have to worry about ever removing relationships (or archiving prices) because if there is a change
+	 * in price information on a ticket, a new ticket is created anyways so the archived ticket will retain the old
+	 * price info and prices are automatically "archived" via the ticket.
+	 *
+	 * @access  private
+	 * @param array     $prices        Array of prices from the form.
+	 * @param EE_Ticket $ticket        EE_Ticket object that prices are being attached to.
+	 * @param bool      $new_prices    Whether attach existing incoming prices or create new ones.
+	 * @param int|bool  $base_price    if FALSE then NOT doing a base price add.
+	 * @param int|bool  $base_price_id if present then this is the base_price_id being updated.
+	 * @return EE_Ticket
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _add_prices_to_ticket(
+		$prices = array(),
+		EE_Ticket $ticket,
+		$new_prices = false,
+		$base_price = false,
+		$base_price_id = false
+	) {
+		// let's just get any current prices that may exist on the given ticket
+		// so we can remove any prices that got trashed in this session.
+		$current_prices_on_ticket = $base_price !== false
+			? $ticket->base_price(true)
+			: $ticket->price_modifiers();
+		$updated_prices           = array();
+		// if $base_price ! FALSE then updating a base price.
+		if ($base_price !== false) {
+			$prices[1] = array(
+				'PRC_ID'     => $new_prices || $base_price_id === 1 ? null : $base_price_id,
+				'PRT_ID'     => 1,
+				'PRC_amount' => $base_price,
+				'PRC_name'   => $ticket->get('TKT_name'),
+				'PRC_desc'   => $ticket->get('TKT_description'),
+			);
+		}
+		//possibly need to save tkt
+		if (! $ticket->ID()) {
+			$ticket->save();
+		}
+		foreach ($prices as $row => $prc) {
+			$prt_id = ! empty($prc['PRT_ID']) ? $prc['PRT_ID'] : null;
+			if (empty($prt_id)) {
+				continue;
+			} //prices MUST have a price type id.
+			$PRC_values = array(
+				'PRC_ID'         => ! empty($prc['PRC_ID']) ? $prc['PRC_ID'] : null,
+				'PRT_ID'         => $prt_id,
+				'PRC_amount'     => ! empty($prc['PRC_amount']) ? $prc['PRC_amount'] : 0,
+				'PRC_name'       => ! empty($prc['PRC_name']) ? $prc['PRC_name'] : '',
+				'PRC_desc'       => ! empty($prc['PRC_desc']) ? $prc['PRC_desc'] : '',
+				'PRC_is_default' => false,
+				//make sure we set PRC_is_default to false for all ticket saves from event_editor
+				'PRC_order'      => $row,
+			);
+			if ($new_prices || empty($PRC_values['PRC_ID'])) {
+				$PRC_values['PRC_ID'] = 0;
+				$price                = EE_Registry::instance()->load_class(
+					'Price',
+					array($PRC_values),
+					false,
+					false
+				);
+			} else {
+				$price = EE_Registry::instance()->load_model('Price')->get_one_by_ID($prc['PRC_ID']);
+				//update this price with new values
+				foreach ($PRC_values as $field => $value) {
+					$price->set($field, $value);
+				}
+			}
+			$price->save();
+			$updated_prices[ $price->ID() ] = $price;
+			$ticket->_add_relation_to($price, 'Price');
+		}
+		//now let's remove any prices that got removed from the ticket
+		if (! empty ($current_prices_on_ticket)) {
+			$current          = array_keys($current_prices_on_ticket);
+			$updated          = array_keys($updated_prices);
+			$prices_to_remove = array_diff($current, $updated);
+			if (! empty($prices_to_remove)) {
+				foreach ($prices_to_remove as $prc_id) {
+					$p = $current_prices_on_ticket[ $prc_id ];
+					$ticket->_remove_relation_to($p, 'Price');
+					//delete permanently the price
+					$p->delete_permanently();
+				}
+			}
+		}
+		return $ticket;
+	}
 
 
-    /**
-     * @param Events_Admin_Page $event_admin_obj
-     * @return Events_Admin_Page
-     */
-    public function autosave_handling(Events_Admin_Page $event_admin_obj)
-    {
-        return $event_admin_obj;
-        //doing nothing for the moment.
-        // todo when I get to this remember that I need to set the template args on the $event_admin_obj
-        // (use the set_template_args() method)
-        /**
-         * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
-         * 1. TKT_is_default_selector (visible)
-         * 2. TKT_is_default (hidden)
-         * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket
-         * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want
-         * this ticket to be saved as a default.
-         * The tricky part is, on an initial display on create or edit (or after manually updating),
-         * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true
-         * if this is a create.  However, after an autosave, users will want some sort of indicator that
-         * the TKT HAS been saved as a default..
-         * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
-         * On Autosave:
-         * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements,
-         * then set the TKT_is_default to false.
-         * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).
-         *  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
-         * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
-         */
-    }
+	/**
+	 * @param Events_Admin_Page $event_admin_obj
+	 * @return Events_Admin_Page
+	 */
+	public function autosave_handling(Events_Admin_Page $event_admin_obj)
+	{
+		return $event_admin_obj;
+		//doing nothing for the moment.
+		// todo when I get to this remember that I need to set the template args on the $event_admin_obj
+		// (use the set_template_args() method)
+		/**
+		 * need to remember to handle TICKET DEFAULT saves correctly:  I've got two input fields in the dom:
+		 * 1. TKT_is_default_selector (visible)
+		 * 2. TKT_is_default (hidden)
+		 * I think we'll use the TKT_is_default for recording whether the ticket displayed IS a default ticket
+		 * (on new event creations). Whereas the TKT_is_default_selector is for the user to indicate they want
+		 * this ticket to be saved as a default.
+		 * The tricky part is, on an initial display on create or edit (or after manually updating),
+		 * the TKT_is_default_selector will always be unselected and the TKT_is_default will only be true
+		 * if this is a create.  However, after an autosave, users will want some sort of indicator that
+		 * the TKT HAS been saved as a default..
+		 * in other words we don't want to remove the check on TKT_is_default_selector. So here's what I'm thinking.
+		 * On Autosave:
+		 * 1. If TKT_is_default is true: we create a new TKT, send back the new id and add id to related elements,
+		 * then set the TKT_is_default to false.
+		 * 2. If TKT_is_default_selector is true: we create/edit existing ticket (following conditions above as well).
+		 *  We do NOT create a new default ticket.  The checkbox stays selected after autosave.
+		 * 3. only on MANUAL update do we check for the selection and if selected create the new default ticket.
+		 */
+	}
 
 
-    /**
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    public function pricing_metabox()
-    {
-        $existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
-        $event                 = $this->_adminpage_obj->get_cpt_model_obj();
-        //set is_creating_event property.
-        $EVT_ID                   = $event->ID();
-        $this->_is_creating_event = absint($EVT_ID) === 0;
-        //default main template args
-        $main_template_args = array(
-            'event_datetime_help_link' => EEH_Template::get_help_tab_link(
-                'event_editor_event_datetimes_help_tab',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            // todo need to add a filter to the template for the help text
-            // in the Events_Admin_Page core file so we can add further help
-            'existing_datetime_ids'    => '',
-            'total_dtt_rows'           => 1,
-            'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link(
-                'add_new_dtt_info',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'datetime_rows'            => '',
-            'show_tickets_container'   => '',
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
-            'ticket_rows'              => '',
-            'existing_ticket_ids'      => '',
-            'total_ticket_rows'        => 1,
-            'ticket_js_structure'      => '',
-            'ee_collapsible_status'    => ' ee-collapsible-open'
-            //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
-        );
-        $timezone           = $event instanceof EE_Event ? $event->timezone_string() : null;
-        do_action('AHEE_log', __FILE__, __FUNCTION__, '');
-        /**
-         * 1. Start with retrieving Datetimes
-         * 2. For each datetime get related tickets
-         * 3. For each ticket get related prices
-         */
-        /** @var EEM_Datetime $datetime_model */
-        $datetime_model                       = EE_Registry::instance()->load_model('Datetime', array($timezone));
-        $datetimes                            = $datetime_model->get_all_event_dates($EVT_ID);
-        $main_template_args['total_dtt_rows'] = count($datetimes);
-        /**
-         * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486
-         * for why we are counting $datetime_row and then setting that on the Datetime object
-         */
-        $datetime_row = 1;
-        foreach ($datetimes as $datetime) {
-            $DTT_ID = $datetime->get('DTT_ID');
-            $datetime->set('DTT_order', $datetime_row);
-            $existing_datetime_ids[] = $DTT_ID;
-            //tickets attached
-            $related_tickets = $datetime->ID() > 0
-                ? $datetime->get_many_related(
-                    'Ticket',
-                    array(
-                        array(
-                            'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0),
-                        ),
-                        'default_where_conditions' => 'none',
-                        'order_by'                 => array('TKT_order' => 'ASC'),
-                    )
-                )
-                : array();
-            //if there are no related tickets this is likely a new event OR autodraft
-            // event so we need to generate the default tickets because datetimes
-            // ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
-            // datetime on the event.
-            if (empty ($related_tickets) && count($datetimes) < 2) {
-                /** @var EEM_Ticket $ticket_model */
-                $ticket_model    = EE_Registry::instance()->load_model('Ticket');
-                $related_tickets = $ticket_model->get_all_default_tickets();
-                // this should be ordered by TKT_ID, so let's grab the first default ticket
-                // (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
-                $default_prices      = EEM_Price::instance()->get_all_default_prices();
-                $main_default_ticket = reset($related_tickets);
-                if ($main_default_ticket instanceof EE_Ticket) {
-                    foreach ($default_prices as $default_price) {
-                        if ($default_price instanceof EE_Price && $default_price->is_base_price()) {
-                            continue;
-                        }
-                        $main_default_ticket->cache('Price', $default_price);
-                    }
-                }
-            }
-            // we can't actually setup rows in this loop yet cause we don't know all
-            // the unique tickets for this event yet (tickets are linked through all datetimes).
-            // So we're going to temporarily cache some of that information.
-            //loop through and setup the ticket rows and make sure the order is set.
-            foreach ($related_tickets as $ticket) {
-                $TKT_ID     = $ticket->get('TKT_ID');
-                $ticket_row = $ticket->get('TKT_row');
-                //we only want unique tickets in our final display!!
-                if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
-                    $existing_ticket_ids[] = $TKT_ID;
-                    $all_tickets[]         = $ticket;
-                }
-                //temporary cache of this ticket info for this datetime for later processing of datetime rows.
-                $datetime_tickets[ $DTT_ID ][] = $ticket_row;
-                //temporary cache of this datetime info for this ticket for later processing of ticket rows.
-                if (
-                    ! isset($ticket_datetimes[ $TKT_ID ])
-                    || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true)
-                ) {
-                    $ticket_datetimes[ $TKT_ID ][] = $datetime_row;
-                }
-            }
-            $datetime_row++;
-        }
-        $main_template_args['total_ticket_rows']     = count($existing_ticket_ids);
-        $main_template_args['existing_ticket_ids']   = implode(',', $existing_ticket_ids);
-        $main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
-        //sort $all_tickets by order
-        usort(
-            $all_tickets,
-            function (EE_Ticket $a, EE_Ticket $b)
-            {
-                $a_order = (int) $a->get('TKT_order');
-                $b_order = (int) $b->get('TKT_order');
-                if ($a_order === $b_order) {
-                    return 0;
-                }
-                return ($a_order < $b_order) ? -1 : 1;
-            }
-        );
-        // k NOW we have all the data we need for setting up the dtt rows
-        // and ticket rows so we start our dtt loop again.
-        $datetime_row = 1;
-        foreach ($datetimes as $datetime) {
-            $main_template_args['datetime_rows'] .= $this->_get_datetime_row(
-                $datetime_row,
-                $datetime,
-                $datetime_tickets,
-                $all_tickets,
-                false,
-                $datetimes
-            );
-            $datetime_row++;
-        }
-        //then loop through all tickets for the ticket rows.
-        $ticket_row = 1;
-        foreach ($all_tickets as $ticket) {
-            $main_template_args['ticket_rows'] .= $this->_get_ticket_row(
-                $ticket_row,
-                $ticket,
-                $ticket_datetimes,
-                $datetimes,
-                false,
-                $all_tickets
-            );
-            $ticket_row++;
-        }
-        $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets);
-        EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
-            $main_template_args
-        );
-    }
+	/**
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	public function pricing_metabox()
+	{
+		$existing_datetime_ids = $existing_ticket_ids = $datetime_tickets = $ticket_datetimes = array();
+		$event                 = $this->_adminpage_obj->get_cpt_model_obj();
+		//set is_creating_event property.
+		$EVT_ID                   = $event->ID();
+		$this->_is_creating_event = absint($EVT_ID) === 0;
+		//default main template args
+		$main_template_args = array(
+			'event_datetime_help_link' => EEH_Template::get_help_tab_link(
+				'event_editor_event_datetimes_help_tab',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			// todo need to add a filter to the template for the help text
+			// in the Events_Admin_Page core file so we can add further help
+			'existing_datetime_ids'    => '',
+			'total_dtt_rows'           => 1,
+			'add_new_dtt_help_link'    => EEH_Template::get_help_tab_link(
+				'add_new_dtt_info',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'datetime_rows'            => '',
+			'show_tickets_container'   => '',
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 1 ? ' style="display:none;"' : '',
+			'ticket_rows'              => '',
+			'existing_ticket_ids'      => '',
+			'total_ticket_rows'        => 1,
+			'ticket_js_structure'      => '',
+			'ee_collapsible_status'    => ' ee-collapsible-open'
+			//$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
+		);
+		$timezone           = $event instanceof EE_Event ? $event->timezone_string() : null;
+		do_action('AHEE_log', __FILE__, __FUNCTION__, '');
+		/**
+		 * 1. Start with retrieving Datetimes
+		 * 2. For each datetime get related tickets
+		 * 3. For each ticket get related prices
+		 */
+		/** @var EEM_Datetime $datetime_model */
+		$datetime_model                       = EE_Registry::instance()->load_model('Datetime', array($timezone));
+		$datetimes                            = $datetime_model->get_all_event_dates($EVT_ID);
+		$main_template_args['total_dtt_rows'] = count($datetimes);
+		/**
+		 * @see https://events.codebasehq.com/projects/event-espresso/tickets/9486
+		 * for why we are counting $datetime_row and then setting that on the Datetime object
+		 */
+		$datetime_row = 1;
+		foreach ($datetimes as $datetime) {
+			$DTT_ID = $datetime->get('DTT_ID');
+			$datetime->set('DTT_order', $datetime_row);
+			$existing_datetime_ids[] = $DTT_ID;
+			//tickets attached
+			$related_tickets = $datetime->ID() > 0
+				? $datetime->get_many_related(
+					'Ticket',
+					array(
+						array(
+							'OR' => array('TKT_deleted' => 1, 'TKT_deleted*' => 0),
+						),
+						'default_where_conditions' => 'none',
+						'order_by'                 => array('TKT_order' => 'ASC'),
+					)
+				)
+				: array();
+			//if there are no related tickets this is likely a new event OR autodraft
+			// event so we need to generate the default tickets because datetimes
+			// ALWAYS have at least one related ticket!!.  EXCEPT, we dont' do this if there is already more than one
+			// datetime on the event.
+			if (empty ($related_tickets) && count($datetimes) < 2) {
+				/** @var EEM_Ticket $ticket_model */
+				$ticket_model    = EE_Registry::instance()->load_model('Ticket');
+				$related_tickets = $ticket_model->get_all_default_tickets();
+				// this should be ordered by TKT_ID, so let's grab the first default ticket
+				// (which will be the main default) and ensure it has any default prices added to it (but do NOT save).
+				$default_prices      = EEM_Price::instance()->get_all_default_prices();
+				$main_default_ticket = reset($related_tickets);
+				if ($main_default_ticket instanceof EE_Ticket) {
+					foreach ($default_prices as $default_price) {
+						if ($default_price instanceof EE_Price && $default_price->is_base_price()) {
+							continue;
+						}
+						$main_default_ticket->cache('Price', $default_price);
+					}
+				}
+			}
+			// we can't actually setup rows in this loop yet cause we don't know all
+			// the unique tickets for this event yet (tickets are linked through all datetimes).
+			// So we're going to temporarily cache some of that information.
+			//loop through and setup the ticket rows and make sure the order is set.
+			foreach ($related_tickets as $ticket) {
+				$TKT_ID     = $ticket->get('TKT_ID');
+				$ticket_row = $ticket->get('TKT_row');
+				//we only want unique tickets in our final display!!
+				if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
+					$existing_ticket_ids[] = $TKT_ID;
+					$all_tickets[]         = $ticket;
+				}
+				//temporary cache of this ticket info for this datetime for later processing of datetime rows.
+				$datetime_tickets[ $DTT_ID ][] = $ticket_row;
+				//temporary cache of this datetime info for this ticket for later processing of ticket rows.
+				if (
+					! isset($ticket_datetimes[ $TKT_ID ])
+					|| ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true)
+				) {
+					$ticket_datetimes[ $TKT_ID ][] = $datetime_row;
+				}
+			}
+			$datetime_row++;
+		}
+		$main_template_args['total_ticket_rows']     = count($existing_ticket_ids);
+		$main_template_args['existing_ticket_ids']   = implode(',', $existing_ticket_ids);
+		$main_template_args['existing_datetime_ids'] = implode(',', $existing_datetime_ids);
+		//sort $all_tickets by order
+		usort(
+			$all_tickets,
+			function (EE_Ticket $a, EE_Ticket $b)
+			{
+				$a_order = (int) $a->get('TKT_order');
+				$b_order = (int) $b->get('TKT_order');
+				if ($a_order === $b_order) {
+					return 0;
+				}
+				return ($a_order < $b_order) ? -1 : 1;
+			}
+		);
+		// k NOW we have all the data we need for setting up the dtt rows
+		// and ticket rows so we start our dtt loop again.
+		$datetime_row = 1;
+		foreach ($datetimes as $datetime) {
+			$main_template_args['datetime_rows'] .= $this->_get_datetime_row(
+				$datetime_row,
+				$datetime,
+				$datetime_tickets,
+				$all_tickets,
+				false,
+				$datetimes
+			);
+			$datetime_row++;
+		}
+		//then loop through all tickets for the ticket rows.
+		$ticket_row = 1;
+		foreach ($all_tickets as $ticket) {
+			$main_template_args['ticket_rows'] .= $this->_get_ticket_row(
+				$ticket_row,
+				$ticket,
+				$ticket_datetimes,
+				$datetimes,
+				false,
+				$all_tickets
+			);
+			$ticket_row++;
+		}
+		$main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets);
+		EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
+			$main_template_args
+		);
+	}
 
 
-    /**
-     * @param int         $datetime_row
-     * @param EE_Datetime $datetime
-     * @param array       $datetime_tickets
-     * @param array       $all_tickets
-     * @param bool        $default
-     * @param array       $all_datetimes
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_datetime_row(
-        $datetime_row,
-        EE_Datetime $datetime,
-        $datetime_tickets = array(),
-        $all_tickets = array(),
-        $default = false,
-        $all_datetimes = array()
-    ) {
-        $dtt_display_template_args = array(
-            'dtt_edit_row'             => $this->_get_dtt_edit_row(
-                $datetime_row,
-                $datetime,
-                $default,
-                $all_datetimes
-            ),
-            'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row(
-                $datetime_row,
-                $datetime,
-                $datetime_tickets,
-                $all_tickets,
-                $default
-            ),
-            'dtt_row'                  => $default ? 'DTTNUM' : $datetime_row,
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
-            $dtt_display_template_args,
-            true
-        );
-    }
+	/**
+	 * @param int         $datetime_row
+	 * @param EE_Datetime $datetime
+	 * @param array       $datetime_tickets
+	 * @param array       $all_tickets
+	 * @param bool        $default
+	 * @param array       $all_datetimes
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_row(
+		$datetime_row,
+		EE_Datetime $datetime,
+		$datetime_tickets = array(),
+		$all_tickets = array(),
+		$default = false,
+		$all_datetimes = array()
+	) {
+		$dtt_display_template_args = array(
+			'dtt_edit_row'             => $this->_get_dtt_edit_row(
+				$datetime_row,
+				$datetime,
+				$default,
+				$all_datetimes
+			),
+			'dtt_attached_tickets_row' => $this->_get_dtt_attached_tickets_row(
+				$datetime_row,
+				$datetime,
+				$datetime_tickets,
+				$all_tickets,
+				$default
+			),
+			'dtt_row'                  => $default ? 'DTTNUM' : $datetime_row,
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
+			$dtt_display_template_args,
+			true
+		);
+	}
 
 
-    /**
-     * This method is used to generate a dtt fields  edit row.
-     * The same row is used to generate a row with valid DTT objects
-     * and the default row that is used as the skeleton by the js.
-     *
-     * @param int           $datetime_row  The row number for the row being generated.
-     * @param EE_Datetime   $datetime
-     * @param bool          $default       Whether a default row is being generated or not.
-     * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor.
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes)
-    {
-        // if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true.
-        $default                     = ! $datetime instanceof EE_Datetime ? true : $default;
-        $template_args               = array(
-            'dtt_row'              => $default ? 'DTTNUM' : $datetime_row,
-            'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'edit_dtt_expanded'    => '',
-            'DTT_ID'               => $default ? '' : $datetime->ID(),
-            'DTT_name'             => $default ? '' : $datetime->get_f('DTT_name'),
-            'DTT_description'      => $default ? '' : $datetime->get_f('DTT_description'),
-            'DTT_EVT_start'        => $default ? '' : $datetime->start_date($this->_date_time_format),
-            'DTT_EVT_end'          => $default ? '' : $datetime->end_date($this->_date_time_format),
-            'DTT_reg_limit'        => $default
-                ? ''
-                : $datetime->get_pretty(
-                    'DTT_reg_limit',
-                    'input'
-                ),
-            'DTT_order'            => $default ? 'DTTNUM' : $datetime_row,
-            'dtt_sold'             => $default ? '0' : $datetime->get('DTT_sold'),
-            'dtt_reserved'         => $default ? '0' : $datetime->reserved(),
-            'clone_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
-                ? ''
-                : 'clone-icon ee-icon ee-icon-clone clickable',
-            'trash_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
-                ? 'ee-lock-icon'
-                : 'trash-icon dashicons dashicons-post-trash clickable',
-            'reg_list_url'         => $default || ! $datetime->event() instanceof \EE_Event
-                ? ''
-                : EE_Admin_Page::add_query_args_and_nonce(
-                    array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()),
-                    REG_ADMIN_URL
-                ),
-        );
-        $template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
-            ? ' style="display:none"'
-            : '';
-        //allow filtering of template args at this point.
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
-            $template_args,
-            $datetime_row,
-            $datetime,
-            $default,
-            $all_datetimes,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * This method is used to generate a dtt fields  edit row.
+	 * The same row is used to generate a row with valid DTT objects
+	 * and the default row that is used as the skeleton by the js.
+	 *
+	 * @param int           $datetime_row  The row number for the row being generated.
+	 * @param EE_Datetime   $datetime
+	 * @param bool          $default       Whether a default row is being generated or not.
+	 * @param EE_Datetime[] $all_datetimes This is the array of all datetimes used in the editor.
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_dtt_edit_row($datetime_row, $datetime, $default, $all_datetimes)
+	{
+		// if the incoming $datetime object is NOT an instance of EE_Datetime then force default to true.
+		$default                     = ! $datetime instanceof EE_Datetime ? true : $default;
+		$template_args               = array(
+			'dtt_row'              => $default ? 'DTTNUM' : $datetime_row,
+			'event_datetimes_name' => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'edit_dtt_expanded'    => '',
+			'DTT_ID'               => $default ? '' : $datetime->ID(),
+			'DTT_name'             => $default ? '' : $datetime->get_f('DTT_name'),
+			'DTT_description'      => $default ? '' : $datetime->get_f('DTT_description'),
+			'DTT_EVT_start'        => $default ? '' : $datetime->start_date($this->_date_time_format),
+			'DTT_EVT_end'          => $default ? '' : $datetime->end_date($this->_date_time_format),
+			'DTT_reg_limit'        => $default
+				? ''
+				: $datetime->get_pretty(
+					'DTT_reg_limit',
+					'input'
+				),
+			'DTT_order'            => $default ? 'DTTNUM' : $datetime_row,
+			'dtt_sold'             => $default ? '0' : $datetime->get('DTT_sold'),
+			'dtt_reserved'         => $default ? '0' : $datetime->reserved(),
+			'clone_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
+				? ''
+				: 'clone-icon ee-icon ee-icon-clone clickable',
+			'trash_icon'           => ! empty($datetime) && $datetime->get('DTT_sold') > 0
+				? 'ee-lock-icon'
+				: 'trash-icon dashicons dashicons-post-trash clickable',
+			'reg_list_url'         => $default || ! $datetime->event() instanceof \EE_Event
+				? ''
+				: EE_Admin_Page::add_query_args_and_nonce(
+					array('event_id' => $datetime->event()->ID(), 'datetime_id' => $datetime->ID()),
+					REG_ADMIN_URL
+				),
+		);
+		$template_args['show_trash'] = count($all_datetimes) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
+			? ' style="display:none"'
+			: '';
+		//allow filtering of template args at this point.
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_dtt_edit_row__template_args',
+			$template_args,
+			$datetime_row,
+			$datetime,
+			$default,
+			$all_datetimes,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int         $datetime_row
-     * @param EE_Datetime $datetime
-     * @param array       $datetime_tickets
-     * @param array       $all_tickets
-     * @param bool        $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_dtt_attached_tickets_row(
-        $datetime_row,
-        $datetime,
-        $datetime_tickets = array(),
-        $all_tickets = array(),
-        $default
-    ) {
-        $template_args = array(
-            'dtt_row'                           => $default ? 'DTTNUM' : $datetime_row,
-            'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
-            'DTT_description'                   => $default ? '' : $datetime->get_f('DTT_description'),
-            'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
-            'show_tickets_row'                  => ' style="display:none;"',
-            'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link(
-                'add_new_ticket_via_datetime',
-                $this->_adminpage_obj->page_slug,
-                $this->_adminpage_obj->get_req_action(),
-                false,
-                false
-            ),
-            //todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
-            'DTT_ID'                            => $default ? '' : $datetime->ID(),
-        );
-        //need to setup the list items (but only if this isn't a default skeleton setup)
-        if (! $default) {
-            $ticket_row = 1;
-            foreach ($all_tickets as $ticket) {
-                $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
-                    $datetime_row,
-                    $ticket_row,
-                    $datetime,
-                    $ticket,
-                    $datetime_tickets,
-                    $default
-                );
-                $ticket_row++;
-            }
-        }
-        //filter template args at this point
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
-            $template_args,
-            $datetime_row,
-            $datetime,
-            $datetime_tickets,
-            $all_tickets,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int         $datetime_row
+	 * @param EE_Datetime $datetime
+	 * @param array       $datetime_tickets
+	 * @param array       $all_tickets
+	 * @param bool        $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_dtt_attached_tickets_row(
+		$datetime_row,
+		$datetime,
+		$datetime_tickets = array(),
+		$all_tickets = array(),
+		$default
+	) {
+		$template_args = array(
+			'dtt_row'                           => $default ? 'DTTNUM' : $datetime_row,
+			'event_datetimes_name'              => $default ? 'DTTNAMEATTR' : 'edit_event_datetimes',
+			'DTT_description'                   => $default ? '' : $datetime->get_f('DTT_description'),
+			'datetime_tickets_list'             => $default ? '<li class="hidden"></li>' : '',
+			'show_tickets_row'                  => ' style="display:none;"',
+			'add_new_datetime_ticket_help_link' => EEH_Template::get_help_tab_link(
+				'add_new_ticket_via_datetime',
+				$this->_adminpage_obj->page_slug,
+				$this->_adminpage_obj->get_req_action(),
+				false,
+				false
+			),
+			//todo need to add this help info id to the Events_Admin_Page core file so we can access it here.
+			'DTT_ID'                            => $default ? '' : $datetime->ID(),
+		);
+		//need to setup the list items (but only if this isn't a default skeleton setup)
+		if (! $default) {
+			$ticket_row = 1;
+			foreach ($all_tickets as $ticket) {
+				$template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
+					$datetime_row,
+					$ticket_row,
+					$datetime,
+					$ticket,
+					$datetime_tickets,
+					$default
+				);
+				$ticket_row++;
+			}
+		}
+		//filter template args at this point
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_dtt_attached_ticket_row__template_args',
+			$template_args,
+			$datetime_row,
+			$datetime,
+			$datetime_tickets,
+			$all_tickets,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int         $datetime_row
-     * @param int         $ticket_row
-     * @param EE_Datetime $datetime
-     * @param EE_Ticket   $ticket
-     * @param array       $datetime_tickets
-     * @param bool        $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_datetime_tickets_list_item(
-        $datetime_row,
-        $ticket_row,
-        $datetime,
-        $ticket,
-        $datetime_tickets = array(),
-        $default
-    ) {
-        $dtt_tkts      = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ])
-            ? $datetime_tickets[ $datetime->ID() ]
-            : array();
-        $display_row   = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
-        $no_ticket     = $default && empty($ticket);
-        $template_args = array(
-            'dtt_row'                 => $default
-                ? 'DTTNUM'
-                : $datetime_row,
-            'tkt_row'                 => $no_ticket
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true)
-                ? ' checked="checked"'
-                : '',
-            'ticket_selected'         => in_array($display_row, $dtt_tkts, true)
-                ? ' ticket-selected'
-                : '',
-            'TKT_name'                => $no_ticket
-                ? 'TKTNAME'
-                : $ticket->get('TKT_name'),
-            'tkt_status_class'        => $no_ticket || $this->_is_creating_event
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status(),
-        );
-        //filter template args
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
-            $template_args,
-            $datetime_row,
-            $ticket_row,
-            $datetime,
-            $ticket,
-            $datetime_tickets,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int         $datetime_row
+	 * @param int         $ticket_row
+	 * @param EE_Datetime $datetime
+	 * @param EE_Ticket   $ticket
+	 * @param array       $datetime_tickets
+	 * @param bool        $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime_tickets_list_item(
+		$datetime_row,
+		$ticket_row,
+		$datetime,
+		$ticket,
+		$datetime_tickets = array(),
+		$default
+	) {
+		$dtt_tkts      = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ])
+			? $datetime_tickets[ $datetime->ID() ]
+			: array();
+		$display_row   = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
+		$no_ticket     = $default && empty($ticket);
+		$template_args = array(
+			'dtt_row'                 => $default
+				? 'DTTNUM'
+				: $datetime_row,
+			'tkt_row'                 => $no_ticket
+				? 'TICKETNUM'
+				: $ticket_row,
+			'datetime_ticket_checked' => in_array($display_row, $dtt_tkts, true)
+				? ' checked="checked"'
+				: '',
+			'ticket_selected'         => in_array($display_row, $dtt_tkts, true)
+				? ' ticket-selected'
+				: '',
+			'TKT_name'                => $no_ticket
+				? 'TKTNAME'
+				: $ticket->get('TKT_name'),
+			'tkt_status_class'        => $no_ticket || $this->_is_creating_event
+				? ' tkt-status-' . EE_Ticket::onsale
+				: ' tkt-status-' . $ticket->ticket_status(),
+		);
+		//filter template args
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_datetime_tickets_list_item__template_args',
+			$template_args,
+			$datetime_row,
+			$ticket_row,
+			$datetime,
+			$ticket,
+			$datetime_tickets,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * This generates the ticket row for tickets.
-     * This same method is used to generate both the actual rows and the js skeleton row
-     * (when default === true)
-     *
-     * @param int           $ticket_row       Represents the row number being generated.
-     * @param               $ticket
-     * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket
-     *                                        or empty for default
-     * @param EE_Datetime[] $all_datetimes    All Datetimes on the event or empty for default.
-     * @param bool          $default          Whether default row being generated or not.
-     * @param EE_Ticket[]   $all_tickets      This is an array of all tickets attached to the event
-     *                                        (or empty in the case of defaults)
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_ticket_row(
-        $ticket_row,
-        $ticket,
-        $ticket_datetimes,
-        $all_datetimes,
-        $default = false,
-        $all_tickets = array()
-    ) {
-        // if $ticket is not an instance of EE_Ticket then force default to true.
-        $default = ! $ticket instanceof EE_Ticket ? true : $default;
-        $prices  = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
-            array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
-        // if there is only one price (which would be the base price)
-        // or NO prices and this ticket is a default ticket,
-        // let's just make sure there are no cached default prices on the object.
-        // This is done by not including any query_params.
-        if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
-            $prices = $ticket->prices();
-        }
-        // check if we're dealing with a default ticket in which case
-        // we don't want any starting_ticket_datetime_row values set
-        // (otherwise there won't be any new relationships created for tickets based off of the default ticket).
-        // This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
-        $default_dtt      = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
-        $tkt_datetimes    = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
-            : array();
-        $ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
-        $base_price       = $default ? null : $ticket->base_price();
-        $count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
-        //breaking out complicated condition for ticket_status
-        if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
-        } else {
-            $ticket_status_class = $ticket->is_default()
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status();
-        }
-        //breaking out complicated condition for TKT_taxable
-        if ($default) {
-            $TKT_taxable = '';
-        } else {
-            $TKT_taxable = $ticket->taxable()
-                ? ' checked="checked"'
-                : '';
-        }
-        if ($default) {
-            $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
-        } elseif ($ticket->is_default()) {
-            $TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
-        } else {
-            $TKT_status = $ticket->ticket_status(true);
-        }
-        if ($default) {
-            $TKT_min = '';
-        } else {
-            $TKT_min = $ticket->min();
-            if ($TKT_min === -1 || $TKT_min === 0) {
-                $TKT_min = '';
-            }
-        }
-        $template_args                 = array(
-            'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
-            'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
-            //on initial page load this will always be the correct order.
-            'tkt_status_class'              => $ticket_status_class,
-            'display_edit_tkt_row'          => ' style="display:none;"',
-            'edit_tkt_expanded'             => '',
-            'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
-            'TKT_name'                      => $default ? '' : $ticket->get_f('TKT_name'),
-            'TKT_start_date'                => $default
-                ? ''
-                : $ticket->get_date('TKT_start_date', $this->_date_time_format),
-            'TKT_end_date'                  => $default
-                ? ''
-                : $ticket->get_date('TKT_end_date', $this->_date_time_format),
-            'TKT_status'                    => $TKT_status,
-            'TKT_price'                     => $default
-                ? ''
-                : EEH_Template::format_currency(
-                    $ticket->get_ticket_total_with_taxes(),
-                    false,
-                    false
-                ),
-            'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
-            'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
-            'TKT_qty'                       => $default
-                ? ''
-                : $ticket->get_pretty('TKT_qty', 'symbol'),
-            'TKT_qty_for_input'             => $default
-                ? ''
-                : $ticket->get_pretty('TKT_qty', 'input'),
-            'TKT_uses'                      => $default
-                ? ''
-                : $ticket->get_pretty('TKT_uses', 'input'),
-            'TKT_min'                       => $TKT_min,
-            'TKT_max'                       => $default
-                ? ''
-                : $ticket->get_pretty('TKT_max', 'input'),
-            'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
-            'TKT_reserved'                  => $default ? 0 : $ticket->reserved(),
-            'TKT_registrations'             => $default
-                ? 0
-                : $ticket->count_registrations(
-                    array(
-                        array(
-                            'STS_ID' => array(
-                                '!=',
-                                EEM_Registration::status_id_incomplete,
-                            ),
-                        ),
-                    )
-                ),
-            'TKT_ID'                        => $default ? 0 : $ticket->ID(),
-            'TKT_description'               => $default ? '' : $ticket->get_f('TKT_description'),
-            'TKT_is_default'                => $default ? 0 : $ticket->is_default(),
-            'TKT_required'                  => $default ? 0 : $ticket->required(),
-            'TKT_is_default_selector'       => '',
-            'ticket_price_rows'             => '',
-            'TKT_base_price'                => $default || ! $base_price instanceof EE_Price
-                ? ''
-                : $base_price->get_pretty('PRC_amount', 'localized_float'),
-            'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
-            'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0)
-                ? ''
-                : ' style="display:none;"',
-            'show_price_mod_button'         => count($prices) > 1
-                                               || ($default && $count_price_mods > 0)
-                                               || (! $default && $ticket->deleted())
-                ? ' style="display:none;"'
-                : '',
-            'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
-            'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
-            'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes),
-            'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_datetimes),
-            'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
-            'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
-            'TKT_taxable'                   => $TKT_taxable,
-            'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->taxable()
-                ? ''
-                : ' style="display:none"',
-            'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
-            'TKT_subtotal_amount_display'   => EEH_Template::format_currency(
-                $ticket_subtotal,
-                false,
-                false
-            ),
-            'TKT_subtotal_amount'           => $ticket_subtotal,
-            'tax_rows'                      => $this->_get_tax_rows($ticket_row, $ticket),
-            'disabled'                      => $ticket instanceof EE_Ticket && $ticket->deleted(),
-            'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->deleted()
-                ? ' ticket-archived'
-                : '',
-            'trash_icon'                    => $ticket instanceof EE_Ticket
-                                               && $ticket->deleted()
-                                               && ! $ticket->is_permanently_deleteable()
-                ? 'ee-lock-icon '
-                : 'trash-icon dashicons dashicons-post-trash clickable',
-            'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->deleted()
-                ? ''
-                : 'clone-icon ee-icon ee-icon-clone clickable',
-        );
-        $template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
-            ? ' style="display:none"'
-            : '';
-        //handle rows that should NOT be empty
-        if (empty($template_args['TKT_start_date'])) {
-            //if empty then the start date will be now.
-            $template_args['TKT_start_date']   = date($this->_date_time_format,
-                current_time('timestamp'));
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        if (empty($template_args['TKT_end_date'])) {
-            //get the earliest datetime (if present);
-            $earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0
-                ? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related(
-                    'Datetime',
-                    array('order_by' => array('DTT_EVT_start' => 'ASC'))
-                )
-                : null;
-            if (! empty($earliest_dtt)) {
-                $template_args['TKT_end_date'] = $earliest_dtt->get_datetime(
-                    'DTT_EVT_start',
-                    $this->_date_time_format
-                );
-            } else {
-                //default so let's just use what's been set for the default date-time which is 30 days from now.
-                $template_args['TKT_end_date'] = date(
-                    $this->_date_time_format,
-                    mktime(
-                        24, 0, 0, date('m'), date('d') + 29, date('Y')
-                    )
-                );
-            }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
-        }
-        //generate ticket_datetime items
-        if (! $default) {
-            $datetime_row = 1;
-            foreach ($all_datetimes as $datetime) {
-                $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
-                    $datetime_row,
-                    $ticket_row,
-                    $datetime,
-                    $ticket,
-                    $ticket_datetimes,
-                    $default
-                );
-                $datetime_row++;
-            }
-        }
-        $price_row = 1;
-        foreach ($prices as $price) {
-            if (! $price instanceof EE_Price) {
-                continue;
-            }
-            if ($price->is_base_price()) {
-                $price_row++;
-                continue;
-            }
-            $show_trash                         = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1);
-            $show_create                        = ! (count($prices) > 1 && count($prices) !== $price_row);
-            $template_args['ticket_price_rows'] .= $this->_get_ticket_price_row(
-                $ticket_row,
-                $price_row,
-                $price,
-                $default,
-                $ticket,
-                $show_trash,
-                $show_create
-            );
-            $price_row++;
-        }
-        //filter $template_args
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
-            $template_args,
-            $ticket_row,
-            $ticket,
-            $ticket_datetimes,
-            $all_datetimes,
-            $default,
-            $all_tickets,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * This generates the ticket row for tickets.
+	 * This same method is used to generate both the actual rows and the js skeleton row
+	 * (when default === true)
+	 *
+	 * @param int           $ticket_row       Represents the row number being generated.
+	 * @param               $ticket
+	 * @param EE_Datetime[] $ticket_datetimes Either an array of all datetimes on all tickets indexed by each ticket
+	 *                                        or empty for default
+	 * @param EE_Datetime[] $all_datetimes    All Datetimes on the event or empty for default.
+	 * @param bool          $default          Whether default row being generated or not.
+	 * @param EE_Ticket[]   $all_tickets      This is an array of all tickets attached to the event
+	 *                                        (or empty in the case of defaults)
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_ticket_row(
+		$ticket_row,
+		$ticket,
+		$ticket_datetimes,
+		$all_datetimes,
+		$default = false,
+		$all_tickets = array()
+	) {
+		// if $ticket is not an instance of EE_Ticket then force default to true.
+		$default = ! $ticket instanceof EE_Ticket ? true : $default;
+		$prices  = ! empty($ticket) && ! $default ? $ticket->get_many_related('Price',
+			array('default_where_conditions' => 'none', 'order_by' => array('PRC_order' => 'ASC'))) : array();
+		// if there is only one price (which would be the base price)
+		// or NO prices and this ticket is a default ticket,
+		// let's just make sure there are no cached default prices on the object.
+		// This is done by not including any query_params.
+		if ($ticket instanceof EE_Ticket && $ticket->is_default() && (count($prices) === 1 || empty($prices))) {
+			$prices = $ticket->prices();
+		}
+		// check if we're dealing with a default ticket in which case
+		// we don't want any starting_ticket_datetime_row values set
+		// (otherwise there won't be any new relationships created for tickets based off of the default ticket).
+		// This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
+		$default_dtt      = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
+		$tkt_datetimes    = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
+			? $ticket_datetimes[ $ticket->ID() ]
+			: array();
+		$ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
+		$base_price       = $default ? null : $ticket->base_price();
+		$count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
+		//breaking out complicated condition for ticket_status
+		if ($default) {
+			$ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+		} else {
+			$ticket_status_class = $ticket->is_default()
+				? ' tkt-status-' . EE_Ticket::onsale
+				: ' tkt-status-' . $ticket->ticket_status();
+		}
+		//breaking out complicated condition for TKT_taxable
+		if ($default) {
+			$TKT_taxable = '';
+		} else {
+			$TKT_taxable = $ticket->taxable()
+				? ' checked="checked"'
+				: '';
+		}
+		if ($default) {
+			$TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
+		} elseif ($ticket->is_default()) {
+			$TKT_status = EEH_Template::pretty_status(EE_Ticket::onsale, false, 'sentence');
+		} else {
+			$TKT_status = $ticket->ticket_status(true);
+		}
+		if ($default) {
+			$TKT_min = '';
+		} else {
+			$TKT_min = $ticket->min();
+			if ($TKT_min === -1 || $TKT_min === 0) {
+				$TKT_min = '';
+			}
+		}
+		$template_args                 = array(
+			'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
+			'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
+			//on initial page load this will always be the correct order.
+			'tkt_status_class'              => $ticket_status_class,
+			'display_edit_tkt_row'          => ' style="display:none;"',
+			'edit_tkt_expanded'             => '',
+			'edit_tickets_name'             => $default ? 'TICKETNAMEATTR' : 'edit_tickets',
+			'TKT_name'                      => $default ? '' : $ticket->get_f('TKT_name'),
+			'TKT_start_date'                => $default
+				? ''
+				: $ticket->get_date('TKT_start_date', $this->_date_time_format),
+			'TKT_end_date'                  => $default
+				? ''
+				: $ticket->get_date('TKT_end_date', $this->_date_time_format),
+			'TKT_status'                    => $TKT_status,
+			'TKT_price'                     => $default
+				? ''
+				: EEH_Template::format_currency(
+					$ticket->get_ticket_total_with_taxes(),
+					false,
+					false
+				),
+			'TKT_price_code'                => EE_Registry::instance()->CFG->currency->code,
+			'TKT_price_amount'              => $default ? 0 : $ticket_subtotal,
+			'TKT_qty'                       => $default
+				? ''
+				: $ticket->get_pretty('TKT_qty', 'symbol'),
+			'TKT_qty_for_input'             => $default
+				? ''
+				: $ticket->get_pretty('TKT_qty', 'input'),
+			'TKT_uses'                      => $default
+				? ''
+				: $ticket->get_pretty('TKT_uses', 'input'),
+			'TKT_min'                       => $TKT_min,
+			'TKT_max'                       => $default
+				? ''
+				: $ticket->get_pretty('TKT_max', 'input'),
+			'TKT_sold'                      => $default ? 0 : $ticket->tickets_sold('ticket'),
+			'TKT_reserved'                  => $default ? 0 : $ticket->reserved(),
+			'TKT_registrations'             => $default
+				? 0
+				: $ticket->count_registrations(
+					array(
+						array(
+							'STS_ID' => array(
+								'!=',
+								EEM_Registration::status_id_incomplete,
+							),
+						),
+					)
+				),
+			'TKT_ID'                        => $default ? 0 : $ticket->ID(),
+			'TKT_description'               => $default ? '' : $ticket->get_f('TKT_description'),
+			'TKT_is_default'                => $default ? 0 : $ticket->is_default(),
+			'TKT_required'                  => $default ? 0 : $ticket->required(),
+			'TKT_is_default_selector'       => '',
+			'ticket_price_rows'             => '',
+			'TKT_base_price'                => $default || ! $base_price instanceof EE_Price
+				? ''
+				: $base_price->get_pretty('PRC_amount', 'localized_float'),
+			'TKT_base_price_ID'             => $default || ! $base_price instanceof EE_Price ? 0 : $base_price->ID(),
+			'show_price_modifier'           => count($prices) > 1 || ($default && $count_price_mods > 0)
+				? ''
+				: ' style="display:none;"',
+			'show_price_mod_button'         => count($prices) > 1
+											   || ($default && $count_price_mods > 0)
+											   || (! $default && $ticket->deleted())
+				? ' style="display:none;"'
+				: '',
+			'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
+			'ticket_datetimes_list'         => $default ? '<li class="hidden"></li>' : '',
+			'starting_ticket_datetime_rows' => $default || $default_dtt ? '' : implode(',', $tkt_datetimes),
+			'ticket_datetime_rows'          => $default ? '' : implode(',', $tkt_datetimes),
+			'existing_ticket_price_ids'     => $default ? '' : implode(',', array_keys($prices)),
+			'ticket_template_id'            => $default ? 0 : $ticket->get('TTM_ID'),
+			'TKT_taxable'                   => $TKT_taxable,
+			'display_subtotal'              => $ticket instanceof EE_Ticket && $ticket->taxable()
+				? ''
+				: ' style="display:none"',
+			'price_currency_symbol'         => EE_Registry::instance()->CFG->currency->sign,
+			'TKT_subtotal_amount_display'   => EEH_Template::format_currency(
+				$ticket_subtotal,
+				false,
+				false
+			),
+			'TKT_subtotal_amount'           => $ticket_subtotal,
+			'tax_rows'                      => $this->_get_tax_rows($ticket_row, $ticket),
+			'disabled'                      => $ticket instanceof EE_Ticket && $ticket->deleted(),
+			'ticket_archive_class'          => $ticket instanceof EE_Ticket && $ticket->deleted()
+				? ' ticket-archived'
+				: '',
+			'trash_icon'                    => $ticket instanceof EE_Ticket
+											   && $ticket->deleted()
+											   && ! $ticket->is_permanently_deleteable()
+				? 'ee-lock-icon '
+				: 'trash-icon dashicons dashicons-post-trash clickable',
+			'clone_icon'                    => $ticket instanceof EE_Ticket && $ticket->deleted()
+				? ''
+				: 'clone-icon ee-icon ee-icon-clone clickable',
+		);
+		$template_args['trash_hidden'] = count($all_tickets) === 1 && $template_args['trash_icon'] !== 'ee-lock-icon'
+			? ' style="display:none"'
+			: '';
+		//handle rows that should NOT be empty
+		if (empty($template_args['TKT_start_date'])) {
+			//if empty then the start date will be now.
+			$template_args['TKT_start_date']   = date($this->_date_time_format,
+				current_time('timestamp'));
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+		if (empty($template_args['TKT_end_date'])) {
+			//get the earliest datetime (if present);
+			$earliest_dtt = $this->_adminpage_obj->get_cpt_model_obj()->ID() > 0
+				? $this->_adminpage_obj->get_cpt_model_obj()->get_first_related(
+					'Datetime',
+					array('order_by' => array('DTT_EVT_start' => 'ASC'))
+				)
+				: null;
+			if (! empty($earliest_dtt)) {
+				$template_args['TKT_end_date'] = $earliest_dtt->get_datetime(
+					'DTT_EVT_start',
+					$this->_date_time_format
+				);
+			} else {
+				//default so let's just use what's been set for the default date-time which is 30 days from now.
+				$template_args['TKT_end_date'] = date(
+					$this->_date_time_format,
+					mktime(
+						24, 0, 0, date('m'), date('d') + 29, date('Y')
+					)
+				);
+			}
+			$template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+		}
+		//generate ticket_datetime items
+		if (! $default) {
+			$datetime_row = 1;
+			foreach ($all_datetimes as $datetime) {
+				$template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
+					$datetime_row,
+					$ticket_row,
+					$datetime,
+					$ticket,
+					$ticket_datetimes,
+					$default
+				);
+				$datetime_row++;
+			}
+		}
+		$price_row = 1;
+		foreach ($prices as $price) {
+			if (! $price instanceof EE_Price) {
+				continue;
+			}
+			if ($price->is_base_price()) {
+				$price_row++;
+				continue;
+			}
+			$show_trash                         = ! ((count($prices) > 1 && $price_row === 1) || count($prices) === 1);
+			$show_create                        = ! (count($prices) > 1 && count($prices) !== $price_row);
+			$template_args['ticket_price_rows'] .= $this->_get_ticket_price_row(
+				$ticket_row,
+				$price_row,
+				$price,
+				$default,
+				$ticket,
+				$show_trash,
+				$show_create
+			);
+			$price_row++;
+		}
+		//filter $template_args
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_row__template_args',
+			$template_args,
+			$ticket_row,
+			$ticket,
+			$ticket_datetimes,
+			$all_datetimes,
+			$default,
+			$all_tickets,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int            $ticket_row
-     * @param EE_Ticket|null $ticket
-     * @return string
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_tax_rows($ticket_row, $ticket)
-    {
-        $tax_rows = '';
-        /** @var EE_Price[] $taxes */
-        $taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
-        foreach ($taxes as $tax) {
-            $tax_added     = $this->_get_tax_added($tax, $ticket);
-            $template_args = array(
-                'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable')
-                    ? ''
-                    : ' style="display:none;"',
-                'tax_id'            => $tax->ID(),
-                'tkt_row'           => $ticket_row,
-                'tax_label'         => $tax->get('PRC_name'),
-                'tax_added'         => $tax_added,
-                'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
-                'tax_amount'        => $tax->get('PRC_amount'),
-            );
-            $template_args = apply_filters(
-                'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
-                $template_args,
-                $ticket_row,
-                $ticket,
-                $this->_is_creating_event
-            );
-            $tax_rows      .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
-                $template_args,
-                true
-            );
-        }
-        return $tax_rows;
-    }
+	/**
+	 * @param int            $ticket_row
+	 * @param EE_Ticket|null $ticket
+	 * @return string
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_tax_rows($ticket_row, $ticket)
+	{
+		$tax_rows = '';
+		/** @var EE_Price[] $taxes */
+		$taxes = empty($ticket) ? EE_Taxes::get_taxes_for_admin() : $ticket->get_ticket_taxes_for_admin();
+		foreach ($taxes as $tax) {
+			$tax_added     = $this->_get_tax_added($tax, $ticket);
+			$template_args = array(
+				'display_tax'       => ! empty($ticket) && $ticket->get('TKT_taxable')
+					? ''
+					: ' style="display:none;"',
+				'tax_id'            => $tax->ID(),
+				'tkt_row'           => $ticket_row,
+				'tax_label'         => $tax->get('PRC_name'),
+				'tax_added'         => $tax_added,
+				'tax_added_display' => EEH_Template::format_currency($tax_added, false, false),
+				'tax_amount'        => $tax->get('PRC_amount'),
+			);
+			$template_args = apply_filters(
+				'FHEE__espresso_events_Pricing_Hooks___get_tax_rows__template_args',
+				$template_args,
+				$ticket_row,
+				$ticket,
+				$this->_is_creating_event
+			);
+			$tax_rows      .= EEH_Template::display_template(
+				PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
+				$template_args,
+				true
+			);
+		}
+		return $tax_rows;
+	}
 
 
-    /**
-     * @param EE_Price       $tax
-     * @param EE_Ticket|null $ticket
-     * @return float|int
-     * @throws EE_Error
-     */
-    protected function _get_tax_added(EE_Price $tax, $ticket)
-    {
-        $subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
-        return $subtotal * $tax->get('PRC_amount') / 100;
-    }
+	/**
+	 * @param EE_Price       $tax
+	 * @param EE_Ticket|null $ticket
+	 * @return float|int
+	 * @throws EE_Error
+	 */
+	protected function _get_tax_added(EE_Price $tax, $ticket)
+	{
+		$subtotal = empty($ticket) ? 0 : $ticket->get_ticket_subtotal();
+		return $subtotal * $tax->get('PRC_amount') / 100;
+	}
 
 
-    /**
-     * @param int            $ticket_row
-     * @param int            $price_row
-     * @param EE_Price|null  $price
-     * @param bool           $default
-     * @param EE_Ticket|null $ticket
-     * @param bool           $show_trash
-     * @param bool           $show_create
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_ticket_price_row(
-        $ticket_row,
-        $price_row,
-        $price,
-        $default,
-        $ticket,
-        $show_trash = true,
-        $show_create = true
-    ) {
-        $send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted');
-        $template_args = array(
-            'tkt_row'               => $default && empty($ticket)
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'PRC_order'             => $default && empty($price)
-                ? 'PRICENUM'
-                : $price_row,
-            'edit_prices_name'      => $default && empty($price)
-                ? 'PRICENAMEATTR'
-                : 'edit_prices',
-            'price_type_selector'   => $default && empty($price)
-                ? $this->_get_base_price_template($ticket_row, $price_row, $price, $default)
-                : $this->_get_price_type_selector(
-                    $ticket_row,
-                    $price_row,
-                    $price,
-                    $default,
-                    $send_disabled
-                ),
-            'PRC_ID'                => $default && empty($price)
-                ? 0
-                : $price->ID(),
-            'PRC_is_default'        => $default && empty($price)
-                ? 0
-                : $price->get('PRC_is_default'),
-            'PRC_name'              => $default && empty($price)
-                ? ''
-                : $price->get('PRC_name'),
-            'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
-            'show_plus_or_minus'    => $default && empty($price)
-                ? ''
-                : ' style="display:none;"',
-            'show_plus'             => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price())
-                ? ' style="display:none;"'
-                : '',
-            'show_minus'            => ($default && empty($price)) || ! $price->is_discount()
-                ? ' style="display:none;"'
-                : '',
-            'show_currency_symbol'  => ($default && empty($price)) || $price->is_percent()
-                ? ' style="display:none"'
-                : '',
-            'PRC_amount'            => $default && empty($price)
-                ? 0
-                : $price->get_pretty('PRC_amount',
-                    'localized_float'),
-            'show_percentage'       => ($default && empty($price)) || ! $price->is_percent()
-                ? ' style="display:none;"'
-                : '',
-            'show_trash_icon'       => $show_trash
-                ? ''
-                : ' style="display:none;"',
-            'show_create_button'    => $show_create
-                ? ''
-                : ' style="display:none;"',
-            'PRC_desc'              => $default && empty($price)
-                ? ''
-                : $price->get('PRC_desc'),
-            'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted'),
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $ticket,
-            $show_trash,
-            $show_create,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int            $ticket_row
+	 * @param int            $price_row
+	 * @param EE_Price|null  $price
+	 * @param bool           $default
+	 * @param EE_Ticket|null $ticket
+	 * @param bool           $show_trash
+	 * @param bool           $show_create
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_ticket_price_row(
+		$ticket_row,
+		$price_row,
+		$price,
+		$default,
+		$ticket,
+		$show_trash = true,
+		$show_create = true
+	) {
+		$send_disabled = ! empty($ticket) && $ticket->get('TKT_deleted');
+		$template_args = array(
+			'tkt_row'               => $default && empty($ticket)
+				? 'TICKETNUM'
+				: $ticket_row,
+			'PRC_order'             => $default && empty($price)
+				? 'PRICENUM'
+				: $price_row,
+			'edit_prices_name'      => $default && empty($price)
+				? 'PRICENAMEATTR'
+				: 'edit_prices',
+			'price_type_selector'   => $default && empty($price)
+				? $this->_get_base_price_template($ticket_row, $price_row, $price, $default)
+				: $this->_get_price_type_selector(
+					$ticket_row,
+					$price_row,
+					$price,
+					$default,
+					$send_disabled
+				),
+			'PRC_ID'                => $default && empty($price)
+				? 0
+				: $price->ID(),
+			'PRC_is_default'        => $default && empty($price)
+				? 0
+				: $price->get('PRC_is_default'),
+			'PRC_name'              => $default && empty($price)
+				? ''
+				: $price->get('PRC_name'),
+			'price_currency_symbol' => EE_Registry::instance()->CFG->currency->sign,
+			'show_plus_or_minus'    => $default && empty($price)
+				? ''
+				: ' style="display:none;"',
+			'show_plus'             => ($default && empty($price)) || ($price->is_discount() || $price->is_base_price())
+				? ' style="display:none;"'
+				: '',
+			'show_minus'            => ($default && empty($price)) || ! $price->is_discount()
+				? ' style="display:none;"'
+				: '',
+			'show_currency_symbol'  => ($default && empty($price)) || $price->is_percent()
+				? ' style="display:none"'
+				: '',
+			'PRC_amount'            => $default && empty($price)
+				? 0
+				: $price->get_pretty('PRC_amount',
+					'localized_float'),
+			'show_percentage'       => ($default && empty($price)) || ! $price->is_percent()
+				? ' style="display:none;"'
+				: '',
+			'show_trash_icon'       => $show_trash
+				? ''
+				: ' style="display:none;"',
+			'show_create_button'    => $show_create
+				? ''
+				: ' style="display:none;"',
+			'PRC_desc'              => $default && empty($price)
+				? ''
+				: $price->get('PRC_desc'),
+			'disabled'              => ! empty($ticket) && $ticket->get('TKT_deleted'),
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_price_row__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$ticket,
+			$show_trash,
+			$show_create,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @param bool     $disabled
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false)
-    {
-        if ($price->is_base_price()) {
-            return $this->_get_base_price_template(
-                $ticket_row,
-                $price_row,
-                $price,
-                $default
-            );
-        }
-        return $this->_get_price_modifier_template(
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $disabled
-        );
-    }
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @param bool     $disabled
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_price_type_selector($ticket_row, $price_row, $price, $default, $disabled = false)
+	{
+		if ($price->is_base_price()) {
+			return $this->_get_base_price_template(
+				$ticket_row,
+				$price_row,
+				$price,
+				$default
+			);
+		}
+		return $this->_get_price_modifier_template(
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$disabled
+		);
+	}
 
 
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_base_price_template($ticket_row, $price_row, $price, $default)
-    {
-        $template_args = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
-            'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $price_row,
-            'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
-            'PRT_name'                  => esc_html__('Price', 'event_espresso'),
-            'price_selected_operator'   => '+',
-            'price_selected_is_percent' => 0,
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_base_price_template($ticket_row, $price_row, $price, $default)
+	{
+		$template_args = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
+			'PRC_order'                 => $default && empty($price) ? 'PRICENUM' : $price_row,
+			'PRT_ID'                    => $default && empty($price) ? 1 : $price->get('PRT_ID'),
+			'PRT_name'                  => esc_html__('Price', 'event_espresso'),
+			'price_selected_operator'   => '+',
+			'price_selected_is_percent' => 0,
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_base_price_template__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int      $ticket_row
-     * @param int      $price_row
-     * @param EE_Price $price
-     * @param bool     $default
-     * @param bool     $disabled
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_price_modifier_template(
-        $ticket_row,
-        $price_row,
-        $price,
-        $default,
-        $disabled = false
-    ) {
-        $select_name = $default && ! $price instanceof EE_Price
-            ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
-            : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]';
-        /** @var EEM_Price_Type $price_type_model */
-        $price_type_model       = EE_Registry::instance()->load_model('Price_Type');
-        $price_types            = $price_type_model->get_all(array(
-            array(
-                'OR' => array(
-                    'PBT_ID'  => '2',
-                    'PBT_ID*' => '3',
-                ),
-            ),
-        ));
-        $all_price_types        = $default && ! $price instanceof EE_Price
-            ? array(esc_html__('Select Modifier', 'event_espresso'))
-            : array();
-        $selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type();
-        $price_option_spans     = '';
-        //setup price types for selector
-        foreach ($price_types as $price_type) {
-            if (! $price_type instanceof EE_Price_Type) {
-                continue;
-            }
-            $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name');
-            //while we're in the loop let's setup the option spans used by js
-            $span_args          = array(
-                'PRT_ID'         => $price_type->ID(),
-                'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
-                'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
-            );
-            $price_option_spans .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
-                $span_args,
-                true
-            );
-        }
-        $select_name               = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]'
-            : $select_name;
-        $select_input              = new EE_Select_Input(
-            $all_price_types,
-            array(
-                'default'               => $selected_price_type_id,
-                'html_name'             => $select_name,
-                'html_class'            => 'edit-price-PRT_ID',
-                'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"',
-            )
-        );
-        $price_selected_operator   = $price instanceof EE_Price && $price->is_discount() ? '-' : '+';
-        $price_selected_operator   = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator;
-        $price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0;
-        $price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent;
-        $template_args             = array(
-            'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
-            'PRC_order'                 => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row,
-            'price_modifier_selector'   => $select_input->get_html_for_input(),
-            'main_name'                 => $select_name,
-            'selected_price_type_id'    => $selected_price_type_id,
-            'price_option_spans'        => $price_option_spans,
-            'price_selected_operator'   => $price_selected_operator,
-            'price_selected_is_percent' => $price_selected_is_percent,
-            'disabled'                  => $disabled,
-        );
-        $template_args             = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
-            $template_args,
-            $ticket_row,
-            $price_row,
-            $price,
-            $default,
-            $disabled,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int      $ticket_row
+	 * @param int      $price_row
+	 * @param EE_Price $price
+	 * @param bool     $default
+	 * @param bool     $disabled
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_price_modifier_template(
+		$ticket_row,
+		$price_row,
+		$price,
+		$default,
+		$disabled = false
+	) {
+		$select_name = $default && ! $price instanceof EE_Price
+			? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
+			: 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]';
+		/** @var EEM_Price_Type $price_type_model */
+		$price_type_model       = EE_Registry::instance()->load_model('Price_Type');
+		$price_types            = $price_type_model->get_all(array(
+			array(
+				'OR' => array(
+					'PBT_ID'  => '2',
+					'PBT_ID*' => '3',
+				),
+			),
+		));
+		$all_price_types        = $default && ! $price instanceof EE_Price
+			? array(esc_html__('Select Modifier', 'event_espresso'))
+			: array();
+		$selected_price_type_id = $default && ! $price instanceof EE_Price ? 0 : $price->type();
+		$price_option_spans     = '';
+		//setup price types for selector
+		foreach ($price_types as $price_type) {
+			if (! $price_type instanceof EE_Price_Type) {
+				continue;
+			}
+			$all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name');
+			//while we're in the loop let's setup the option spans used by js
+			$span_args          = array(
+				'PRT_ID'         => $price_type->ID(),
+				'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
+				'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
+			);
+			$price_option_spans .= EEH_Template::display_template(
+				PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
+				$span_args,
+				true
+			);
+		}
+		$select_name               = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]'
+			: $select_name;
+		$select_input              = new EE_Select_Input(
+			$all_price_types,
+			array(
+				'default'               => $selected_price_type_id,
+				'html_name'             => $select_name,
+				'html_class'            => 'edit-price-PRT_ID',
+				'html_other_attributes' => $disabled ? 'style="width:auto;" disabled' : 'style="width:auto;"',
+			)
+		);
+		$price_selected_operator   = $price instanceof EE_Price && $price->is_discount() ? '-' : '+';
+		$price_selected_operator   = $default && ! $price instanceof EE_Price ? '' : $price_selected_operator;
+		$price_selected_is_percent = $price instanceof EE_Price && $price->is_percent() ? 1 : 0;
+		$price_selected_is_percent = $default && ! $price instanceof EE_Price ? '' : $price_selected_is_percent;
+		$template_args             = array(
+			'tkt_row'                   => $default ? 'TICKETNUM' : $ticket_row,
+			'PRC_order'                 => $default && ! $price instanceof EE_Price ? 'PRICENUM' : $price_row,
+			'price_modifier_selector'   => $select_input->get_html_for_input(),
+			'main_name'                 => $select_name,
+			'selected_price_type_id'    => $selected_price_type_id,
+			'price_option_spans'        => $price_option_spans,
+			'price_selected_operator'   => $price_selected_operator,
+			'price_selected_is_percent' => $price_selected_is_percent,
+			'disabled'                  => $disabled,
+		);
+		$template_args             = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
+			$template_args,
+			$ticket_row,
+			$price_row,
+			$price,
+			$default,
+			$disabled,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param int              $datetime_row
-     * @param int              $ticket_row
-     * @param EE_Datetime|null $datetime
-     * @param EE_Ticket|null   $ticket
-     * @param array            $ticket_datetimes
-     * @param bool             $default
-     * @return mixed
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_datetime_list_item(
-        $datetime_row,
-        $ticket_row,
-        $datetime,
-        $ticket,
-        $ticket_datetimes = array(),
-        $default
-    ) {
-        $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
-            : array();
-        $template_args = array(
-            'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
-                ? 'DTTNUM'
-                : $datetime_row,
-            'tkt_row'                  => $default
-                ? 'TICKETNUM'
-                : $ticket_row,
-            'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true)
-                ? ' ticket-selected'
-                : '',
-            'ticket_datetime_checked'  => in_array($datetime_row, $tkt_datetimes, true)
-                ? ' checked="checked"'
-                : '',
-            'DTT_name'                 => $default && empty($datetime)
-                ? 'DTTNAME'
-                : $datetime->get_dtt_display_name(true),
-            'tkt_status_class'         => '',
-        );
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
-            $template_args,
-            $datetime_row,
-            $ticket_row,
-            $datetime,
-            $ticket,
-            $ticket_datetimes,
-            $default,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param int              $datetime_row
+	 * @param int              $ticket_row
+	 * @param EE_Datetime|null $datetime
+	 * @param EE_Ticket|null   $ticket
+	 * @param array            $ticket_datetimes
+	 * @param bool             $default
+	 * @return mixed
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_datetime_list_item(
+		$datetime_row,
+		$ticket_row,
+		$datetime,
+		$ticket,
+		$ticket_datetimes = array(),
+		$default
+	) {
+		$tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
+			? $ticket_datetimes[ $ticket->ID() ]
+			: array();
+		$template_args = array(
+			'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
+				? 'DTTNUM'
+				: $datetime_row,
+			'tkt_row'                  => $default
+				? 'TICKETNUM'
+				: $ticket_row,
+			'ticket_datetime_selected' => in_array($datetime_row, $tkt_datetimes, true)
+				? ' ticket-selected'
+				: '',
+			'ticket_datetime_checked'  => in_array($datetime_row, $tkt_datetimes, true)
+				? ' checked="checked"'
+				: '',
+			'DTT_name'                 => $default && empty($datetime)
+				? 'DTTNAME'
+				: $datetime->get_dtt_display_name(true),
+			'tkt_status_class'         => '',
+		);
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_datetime_list_item__template_args',
+			$template_args,
+			$datetime_row,
+			$ticket_row,
+			$datetime,
+			$ticket,
+			$ticket_datetimes,
+			$default,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
+			$template_args,
+			true
+		);
+	}
 
 
-    /**
-     * @param array $all_datetimes
-     * @param array $all_tickets
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws DomainException
-     * @throws EE_Error
-     */
-    protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array())
-    {
-        $template_args = array(
-            'default_datetime_edit_row'                => $this->_get_dtt_edit_row(
-                'DTTNUM',
-                null,
-                true,
-                $all_datetimes
-            ),
-            'default_ticket_row'                       => $this->_get_ticket_row(
-                'TICKETNUM',
-                null,
-                array(),
-                array(),
-                true
-            ),
-            'default_price_row'                        => $this->_get_ticket_price_row(
-                'TICKETNUM',
-                'PRICENUM',
-                null,
-                true,
-                null
-            ),
-            'default_price_rows'                       => '',
-            'default_base_price_amount'                => 0,
-            'default_base_price_name'                  => '',
-            'default_base_price_description'           => '',
-            'default_price_modifier_selector_row'      => $this->_get_price_modifier_template(
-                'TICKETNUM',
-                'PRICENUM',
-                null,
-                true
-            ),
-            'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row(
-                'DTTNUM',
-                null,
-                array(),
-                array(),
-                true
-            ),
-            'existing_available_datetime_tickets_list' => '',
-            'existing_available_ticket_datetimes_list' => '',
-            'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item(
-                'DTTNUM',
-                'TICKETNUM',
-                null,
-                null,
-                array(),
-                true
-            ),
-            'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item(
-                'DTTNUM',
-                'TICKETNUM',
-                null,
-                null,
-                array(),
-                true
-            ),
-        );
-        $ticket_row    = 1;
-        foreach ($all_tickets as $ticket) {
-            $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
-                'DTTNUM',
-                $ticket_row,
-                null,
-                $ticket,
-                array(),
-                true
-            );
-            $ticket_row++;
-        }
-        $datetime_row = 1;
-        foreach ($all_datetimes as $datetime) {
-            $template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
-                $datetime_row,
-                'TICKETNUM',
-                $datetime,
-                null,
-                array(),
-                true
-            );
-            $datetime_row++;
-        }
-        /** @var EEM_Price $price_model */
-        $price_model    = EE_Registry::instance()->load_model('Price');
-        $default_prices = $price_model->get_all_default_prices();
-        $price_row      = 1;
-        foreach ($default_prices as $price) {
-            if (! $price instanceof EE_Price) {
-                continue;
-            }
-            if ($price->is_base_price()) {
-                $template_args['default_base_price_amount']      = $price->get_pretty(
-                    'PRC_amount',
-                    'localized_float'
-                );
-                $template_args['default_base_price_name']        = $price->get('PRC_name');
-                $template_args['default_base_price_description'] = $price->get('PRC_desc');
-                $price_row++;
-                continue;
-            }
-            $show_trash                          = ! ((count($default_prices) > 1 && $price_row === 1)
-                                                      || count($default_prices) === 1);
-            $show_create                         = ! (count($default_prices) > 1
-                                                      && count($default_prices)
-                                                         !== $price_row);
-            $template_args['default_price_rows'] .= $this->_get_ticket_price_row(
-                'TICKETNUM',
-                $price_row,
-                $price,
-                true,
-                null,
-                $show_trash,
-                $show_create
-            );
-            $price_row++;
-        }
-        $template_args = apply_filters(
-            'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
-            $template_args,
-            $all_datetimes,
-            $all_tickets,
-            $this->_is_creating_event
-        );
-        return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
-            $template_args,
-            true
-        );
-    }
+	/**
+	 * @param array $all_datetimes
+	 * @param array $all_tickets
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws DomainException
+	 * @throws EE_Error
+	 */
+	protected function _get_ticket_js_structure($all_datetimes = array(), $all_tickets = array())
+	{
+		$template_args = array(
+			'default_datetime_edit_row'                => $this->_get_dtt_edit_row(
+				'DTTNUM',
+				null,
+				true,
+				$all_datetimes
+			),
+			'default_ticket_row'                       => $this->_get_ticket_row(
+				'TICKETNUM',
+				null,
+				array(),
+				array(),
+				true
+			),
+			'default_price_row'                        => $this->_get_ticket_price_row(
+				'TICKETNUM',
+				'PRICENUM',
+				null,
+				true,
+				null
+			),
+			'default_price_rows'                       => '',
+			'default_base_price_amount'                => 0,
+			'default_base_price_name'                  => '',
+			'default_base_price_description'           => '',
+			'default_price_modifier_selector_row'      => $this->_get_price_modifier_template(
+				'TICKETNUM',
+				'PRICENUM',
+				null,
+				true
+			),
+			'default_available_tickets_for_datetime'   => $this->_get_dtt_attached_tickets_row(
+				'DTTNUM',
+				null,
+				array(),
+				array(),
+				true
+			),
+			'existing_available_datetime_tickets_list' => '',
+			'existing_available_ticket_datetimes_list' => '',
+			'new_available_datetime_ticket_list_item'  => $this->_get_datetime_tickets_list_item(
+				'DTTNUM',
+				'TICKETNUM',
+				null,
+				null,
+				array(),
+				true
+			),
+			'new_available_ticket_datetime_list_item'  => $this->_get_ticket_datetime_list_item(
+				'DTTNUM',
+				'TICKETNUM',
+				null,
+				null,
+				array(),
+				true
+			),
+		);
+		$ticket_row    = 1;
+		foreach ($all_tickets as $ticket) {
+			$template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
+				'DTTNUM',
+				$ticket_row,
+				null,
+				$ticket,
+				array(),
+				true
+			);
+			$ticket_row++;
+		}
+		$datetime_row = 1;
+		foreach ($all_datetimes as $datetime) {
+			$template_args['existing_available_ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
+				$datetime_row,
+				'TICKETNUM',
+				$datetime,
+				null,
+				array(),
+				true
+			);
+			$datetime_row++;
+		}
+		/** @var EEM_Price $price_model */
+		$price_model    = EE_Registry::instance()->load_model('Price');
+		$default_prices = $price_model->get_all_default_prices();
+		$price_row      = 1;
+		foreach ($default_prices as $price) {
+			if (! $price instanceof EE_Price) {
+				continue;
+			}
+			if ($price->is_base_price()) {
+				$template_args['default_base_price_amount']      = $price->get_pretty(
+					'PRC_amount',
+					'localized_float'
+				);
+				$template_args['default_base_price_name']        = $price->get('PRC_name');
+				$template_args['default_base_price_description'] = $price->get('PRC_desc');
+				$price_row++;
+				continue;
+			}
+			$show_trash                          = ! ((count($default_prices) > 1 && $price_row === 1)
+													  || count($default_prices) === 1);
+			$show_create                         = ! (count($default_prices) > 1
+													  && count($default_prices)
+														 !== $price_row);
+			$template_args['default_price_rows'] .= $this->_get_ticket_price_row(
+				'TICKETNUM',
+				$price_row,
+				$price,
+				true,
+				null,
+				$show_trash,
+				$show_create
+			);
+			$price_row++;
+		}
+		$template_args = apply_filters(
+			'FHEE__espresso_events_Pricing_Hooks___get_ticket_js_structure__template_args',
+			$template_args,
+			$all_datetimes,
+			$all_tickets,
+			$this->_is_creating_event
+		);
+		return EEH_Template::display_template(
+			PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
+			$template_args,
+			true
+		);
+	}
 } //end class espresso_events_Pricing_Hooks

Spacing +90 added lines, -90 removed lines

@@ -52,7 +52,7 @@ 
     {
         $this->_name = 'pricing';
         //capability check
-        if (! EE_Registry::instance()->CAP->current_user_can(
+        if ( ! EE_Registry::instance()->CAP->current_user_can(
             'ee_read_default_prices',
             'advanced_ticket_datetime_metabox'
         )) {
@@ -80,7 +80,7 @@ 
     protected function _setup_metaboxes()
     {
         //if we were going to add our own metaboxes we'd use the below.
-        $this->_metaboxes        = array(
+        $this->_metaboxes = array(
             0 => array(
                 'page_route' => array('edit', 'create_new'),
                 'func'       => 'pricing_metabox',
@@ -152,7 +152,7 @@ 
             );
             $msg .= '</p><ul>';
             foreach ($format_validation as $error) {
-                $msg .= '<li>' . $error . '</li>';
+                $msg .= '<li>'.$error.'</li>';
             }
             $msg .= '</ul><p>';
             $msg .= sprintf(
@@ -181,11 +181,11 @@ 
         $this->_scripts_styles = array(
             'registers'   => array(
                 'ee-tickets-datetimes-css' => array(
-                    'url'  => PRICING_ASSETS_URL . 'event-tickets-datetimes.css',
+                    'url'  => PRICING_ASSETS_URL.'event-tickets-datetimes.css',
                     'type' => 'css',
                 ),
                 'ee-dtt-ticket-metabox'    => array(
-                    'url'     => PRICING_ASSETS_URL . 'ee-datetime-ticket-metabox.js',
+                    'url'     => PRICING_ASSETS_URL.'ee-datetime-ticket-metabox.js',
                     'depends' => array('ee-datepicker', 'ee-dialog', 'underscore'),
                 ),
             ),
@@ -209,9 +209,9 @@ 
                             'event_espresso'
                         ),
                         'cancel_button'           => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Cancel', 'event_espresso') . '</button>',
+                                                     . esc_html__('Cancel', 'event_espresso').'</button>',
                         'close_button'            => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Close', 'event_espresso') . '</button>',
+                                                     . esc_html__('Close', 'event_espresso').'</button>',
                         'single_warning_from_tkt' => esc_html__(
                             'The Datetime you are attempting to unassign from this ticket is the only remaining datetime for this ticket. Tickets must always have at least one datetime assigned to them.',
                             'event_espresso'
@@ -221,7 +221,7 @@ 
                             'event_espresso'
                         ),
                         'dismiss_button'          => '<button class="button-secondary ee-modal-cancel">'
-                                                     . esc_html__('Dismiss', 'event_espresso') . '</button>',
+                                                     . esc_html__('Dismiss', 'event_espresso').'</button>',
                     ),
                     'DTT_ERROR_MSG'         => array(
                         'no_ticket_name' => esc_html__('General Admission', 'event_espresso'),
@@ -259,7 +259,7 @@ 
     {
         foreach ($update_callbacks as $key => $callback) {
             if ($callback[1] === '_default_tickets_update') {
-                unset($update_callbacks[ $key ]);
+                unset($update_callbacks[$key]);
             }
         }
         $update_callbacks[] = array($this, 'datetime_and_tickets_caf_update');
@@ -316,8 +316,8 @@ 
         }
         foreach ($data['edit_event_datetimes'] as $row => $datetime_data) {
             //trim all values to ensure any excess whitespace is removed.
-            $datetime_data                = array_map(
-                function ($datetime_data)
+            $datetime_data = array_map(
+                function($datetime_data)
                 {
                     return is_array($datetime_data) ? $datetime_data : trim($datetime_data);
                 },
@@ -327,7 +327,7 @@ 
                                             && ! empty($datetime_data['DTT_EVT_end'])
                 ? $datetime_data['DTT_EVT_end']
                 : $datetime_data['DTT_EVT_start'];
-            $datetime_values              = array(
+            $datetime_values = array(
                 'DTT_ID'          => ! empty($datetime_data['DTT_ID'])
                     ? $datetime_data['DTT_ID']
                     : null,
@@ -348,7 +348,7 @@ 
             );
             // if we have an id then let's get existing object first and then set the new values.
             // Otherwise we instantiate a new object for save.
-            if (! empty($datetime_data['DTT_ID'])) {
+            if ( ! empty($datetime_data['DTT_ID'])) {
                 $datetime = EE_Registry::instance()
                                        ->load_model('Datetime', array($timezone))
                                        ->get_one_by_ID($datetime_data['DTT_ID']);
@@ -362,7 +362,7 @@ 
                 // after the add_relation_to() the autosave replaces it.
                 // We need to do this so we dont' TRASH the parent DTT.
                 // (save the ID for both key and value to avoid duplications)
-                $saved_dtt_ids[ $datetime->ID() ] = $datetime->ID();
+                $saved_dtt_ids[$datetime->ID()] = $datetime->ID();
             } else {
                 $datetime = EE_Registry::instance()->load_class(
                     'Datetime',
@@ -391,8 +391,8 @@ 
             // because it is possible there was a new one created for the autosave.
             // (save the ID for both key and value to avoid duplications)
             $DTT_ID                   = $datetime->ID();
-            $saved_dtt_ids[ $DTT_ID ] = $DTT_ID;
-            $saved_dtt_objs[ $row ]   = $datetime;
+            $saved_dtt_ids[$DTT_ID] = $DTT_ID;
+            $saved_dtt_objs[$row]   = $datetime;
             //todo if ANY of these updates fail then we want the appropriate global error message.
         }
         $event->save();
@@ -457,13 +457,13 @@ 
             $update_prices = $create_new_TKT = false;
             // figure out what datetimes were added to the ticket
             // and what datetimes were removed from the ticket in the session.
-            $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][ $row ]);
-            $tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][ $row ]);
+            $starting_tkt_dtt_rows = explode(',', $data['starting_ticket_datetime_rows'][$row]);
+            $tkt_dtt_rows          = explode(',', $data['ticket_datetime_rows'][$row]);
             $datetimes_added       = array_diff($tkt_dtt_rows, $starting_tkt_dtt_rows);
             $datetimes_removed     = array_diff($starting_tkt_dtt_rows, $tkt_dtt_rows);
             // trim inputs to ensure any excess whitespace is removed.
             $tkt = array_map(
-                function ($ticket_data)
+                function($ticket_data)
                 {
                     return is_array($ticket_data) ? $ticket_data : trim($ticket_data);
                 },
@@ -486,8 +486,8 @@ 
             $base_price_id = isset($tkt['TKT_base_price_ID'])
                 ? $tkt['TKT_base_price_ID']
                 : 0;
-            $price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][ $row ])
-                ? $data['edit_prices'][ $row ]
+            $price_rows    = is_array($data['edit_prices']) && isset($data['edit_prices'][$row])
+                ? $data['edit_prices'][$row]
                 : array();
             $now           = null;
             if (empty($tkt['TKT_start_date'])) {
@@ -499,7 +499,7 @@ 
                 /**
                  * set the TKT_end_date to the first datetime attached to the ticket.
                  */
-                $first_dtt           = $saved_datetimes[ reset($tkt_dtt_rows) ];
+                $first_dtt           = $saved_datetimes[reset($tkt_dtt_rows)];
                 $tkt['TKT_end_date'] = $first_dtt->start_date_and_time($this->_date_time_format);
             }
             $TKT_values = array(
@@ -600,7 +600,7 @@ 
                 if ($ticket instanceof EE_Ticket) {
                     // make sure ticket has an ID of setting relations won't work
                     $ticket->save();
-                    $ticket        = $this->_update_ticket_datetimes(
+                    $ticket = $this->_update_ticket_datetimes(
                         $ticket,
                         $saved_datetimes,
                         $datetimes_added,
@@ -634,7 +634,7 @@ 
             //need to make sue that the TKT_price is accurate after saving the prices.
             $ticket->ensure_TKT_Price_correct();
             //handle CREATING a default tkt from the incoming tkt but ONLY if this isn't an autosave.
-            if (! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
+            if ( ! defined('DOING_AUTOSAVE') && ! empty($tkt['TKT_is_default_selector'])) {
                 $update_prices = true;
                 $new_default   = clone $ticket;
                 $new_default->set('TKT_ID', 0);
@@ -679,7 +679,7 @@ 
                 //save new TKT
                 $new_tkt->save();
                 //add new ticket to array
-                $saved_tickets[ $new_tkt->ID() ] = $new_tkt;
+                $saved_tickets[$new_tkt->ID()] = $new_tkt;
                 do_action(
                     'AHEE__espresso_events_Pricing_Hooks___update_tkts_new_ticket',
                     $new_tkt,
@@ -689,7 +689,7 @@ 
                 );
             } else {
                 //add tkt to saved tkts
-                $saved_tickets[ $ticket->ID() ] = $ticket;
+                $saved_tickets[$ticket->ID()] = $ticket;
                 do_action(
                     'AHEE__espresso_events_Pricing_Hooks___update_tkts_update_ticket',
                     $ticket,
@@ -756,33 +756,33 @@ 
         // to start we have to add the ticket to all the datetimes its supposed to be with,
         // and removing the ticket from datetimes it got removed from.
         // first let's add datetimes
-        if (! empty($added_datetimes) && is_array($added_datetimes)) {
+        if ( ! empty($added_datetimes) && is_array($added_datetimes)) {
             foreach ($added_datetimes as $row_id) {
                 $row_id = (int) $row_id;
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_add_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+                    $ticket->_add_relation_to($saved_datetimes[$row_id], 'Datetime');
                     // Is this an existing ticket (has an ID) and does it have any sold?
                     // If so, then we need to add that to the DTT sold because this DTT is getting added.
                     if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[ $row_id ]->increase_sold($ticket->sold());
-                        $saved_datetimes[ $row_id ]->save();
+                        $saved_datetimes[$row_id]->increase_sold($ticket->sold());
+                        $saved_datetimes[$row_id]->save();
                     }
                 }
             }
         }
         // then remove datetimes
-        if (! empty($removed_datetimes) && is_array($removed_datetimes)) {
+        if ( ! empty($removed_datetimes) && is_array($removed_datetimes)) {
             foreach ($removed_datetimes as $row_id) {
                 $row_id = (int) $row_id;
                 // its entirely possible that a datetime got deleted (instead of just removed from relationship.
                 // So make sure we skip over this if the dtt isn't in the $saved_datetimes array)
-                if (isset($saved_datetimes[ $row_id ]) && $saved_datetimes[ $row_id ] instanceof EE_Datetime) {
-                    $ticket->_remove_relation_to($saved_datetimes[ $row_id ], 'Datetime');
+                if (isset($saved_datetimes[$row_id]) && $saved_datetimes[$row_id] instanceof EE_Datetime) {
+                    $ticket->_remove_relation_to($saved_datetimes[$row_id], 'Datetime');
                     // Is this an existing ticket (has an ID) and does it have any sold?
                     // If so, then we need to remove it's sold from the DTT_sold.
                     if ($ticket->ID() && $ticket->sold() > 0) {
-                        $saved_datetimes[ $row_id ]->decrease_sold($ticket->sold());
-                        $saved_datetimes[ $row_id ]->save();
+                        $saved_datetimes[$row_id]->decrease_sold($ticket->sold());
+                        $saved_datetimes[$row_id]->save();
                     }
                 }
             }
@@ -895,7 +895,7 @@ 
             );
         }
         //possibly need to save tkt
-        if (! $ticket->ID()) {
+        if ( ! $ticket->ID()) {
             $ticket->save();
         }
         foreach ($prices as $row => $prc) {
@@ -929,17 +929,17 @@ 
                 }
             }
             $price->save();
-            $updated_prices[ $price->ID() ] = $price;
+            $updated_prices[$price->ID()] = $price;
             $ticket->_add_relation_to($price, 'Price');
         }
         //now let's remove any prices that got removed from the ticket
-        if (! empty ($current_prices_on_ticket)) {
+        if ( ! empty ($current_prices_on_ticket)) {
             $current          = array_keys($current_prices_on_ticket);
             $updated          = array_keys($updated_prices);
             $prices_to_remove = array_diff($current, $updated);
-            if (! empty($prices_to_remove)) {
+            if ( ! empty($prices_to_remove)) {
                 foreach ($prices_to_remove as $prc_id) {
-                    $p = $current_prices_on_ticket[ $prc_id ];
+                    $p = $current_prices_on_ticket[$prc_id];
                     $ticket->_remove_relation_to($p, 'Price');
                     //delete permanently the price
                     $p->delete_permanently();
@@ -1028,7 +1028,7 @@ 
             'ee_collapsible_status'    => ' ee-collapsible-open'
             //$this->_adminpage_obj->get_cpt_model_obj()->ID() > 0 ? ' ee-collapsible-closed' : ' ee-collapsible-open'
         );
-        $timezone           = $event instanceof EE_Event ? $event->timezone_string() : null;
+        $timezone = $event instanceof EE_Event ? $event->timezone_string() : null;
         do_action('AHEE_log', __FILE__, __FUNCTION__, '');
         /**
          * 1. Start with retrieving Datetimes
@@ -1090,18 +1090,18 @@ 
                 $TKT_ID     = $ticket->get('TKT_ID');
                 $ticket_row = $ticket->get('TKT_row');
                 //we only want unique tickets in our final display!!
-                if (! in_array($TKT_ID, $existing_ticket_ids, true)) {
+                if ( ! in_array($TKT_ID, $existing_ticket_ids, true)) {
                     $existing_ticket_ids[] = $TKT_ID;
                     $all_tickets[]         = $ticket;
                 }
                 //temporary cache of this ticket info for this datetime for later processing of datetime rows.
-                $datetime_tickets[ $DTT_ID ][] = $ticket_row;
+                $datetime_tickets[$DTT_ID][] = $ticket_row;
                 //temporary cache of this datetime info for this ticket for later processing of ticket rows.
                 if (
-                    ! isset($ticket_datetimes[ $TKT_ID ])
-                    || ! in_array($datetime_row, $ticket_datetimes[ $TKT_ID ], true)
+                    ! isset($ticket_datetimes[$TKT_ID])
+                    || ! in_array($datetime_row, $ticket_datetimes[$TKT_ID], true)
                 ) {
-                    $ticket_datetimes[ $TKT_ID ][] = $datetime_row;
+                    $ticket_datetimes[$TKT_ID][] = $datetime_row;
                 }
             }
             $datetime_row++;
@@ -1112,7 +1112,7 @@ 
         //sort $all_tickets by order
         usort(
             $all_tickets,
-            function (EE_Ticket $a, EE_Ticket $b)
+            function(EE_Ticket $a, EE_Ticket $b)
             {
                 $a_order = (int) $a->get('TKT_order');
                 $b_order = (int) $b->get('TKT_order');
@@ -1151,7 +1151,7 @@ 
         }
         $main_template_args['ticket_js_structure'] = $this->_get_ticket_js_structure($datetimes, $all_tickets);
         EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_metabox_main.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_metabox_main.template.php',
             $main_template_args
         );
     }
@@ -1193,7 +1193,7 @@ 
             'dtt_row'                  => $default ? 'DTTNUM' : $datetime_row,
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_row_wrapper.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_row_wrapper.template.php',
             $dtt_display_template_args,
             true
         );
@@ -1262,7 +1262,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_edit_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_edit_row.template.php',
             $template_args,
             true
         );
@@ -1303,7 +1303,7 @@ 
             'DTT_ID'                            => $default ? '' : $datetime->ID(),
         );
         //need to setup the list items (but only if this isn't a default skeleton setup)
-        if (! $default) {
+        if ( ! $default) {
             $ticket_row = 1;
             foreach ($all_tickets as $ticket) {
                 $template_args['datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
@@ -1329,7 +1329,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_attached_tickets_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_attached_tickets_row.template.php',
             $template_args,
             true
         );
@@ -1355,8 +1355,8 @@ 
         $datetime_tickets = array(),
         $default
     ) {
-        $dtt_tkts      = $datetime instanceof EE_Datetime && isset($datetime_tickets[ $datetime->ID() ])
-            ? $datetime_tickets[ $datetime->ID() ]
+        $dtt_tkts      = $datetime instanceof EE_Datetime && isset($datetime_tickets[$datetime->ID()])
+            ? $datetime_tickets[$datetime->ID()]
             : array();
         $display_row   = $ticket instanceof EE_Ticket ? $ticket->get('TKT_row') : 0;
         $no_ticket     = $default && empty($ticket);
@@ -1377,8 +1377,8 @@ 
                 ? 'TKTNAME'
                 : $ticket->get('TKT_name'),
             'tkt_status_class'        => $no_ticket || $this->_is_creating_event
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status(),
+                ? ' tkt-status-'.EE_Ticket::onsale
+                : ' tkt-status-'.$ticket->ticket_status(),
         );
         //filter template args
         $template_args = apply_filters(
@@ -1393,7 +1393,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_dtt_tickets_list.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_dtt_tickets_list.template.php',
             $template_args,
             true
         );
@@ -1445,19 +1445,19 @@ 
         // (otherwise there won't be any new relationships created for tickets based off of the default ticket).
         // This will future proof in case there is ever any behaviour change between what the primary_key defaults to.
         $default_dtt      = $default || ($ticket instanceof EE_Ticket && $ticket->is_default());
-        $tkt_datetimes    = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
+        $tkt_datetimes    = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+            ? $ticket_datetimes[$ticket->ID()]
             : array();
         $ticket_subtotal  = $default ? 0 : $ticket->get_ticket_subtotal();
         $base_price       = $default ? null : $ticket->base_price();
         $count_price_mods = EEM_Price::instance()->get_all_default_prices(true);
         //breaking out complicated condition for ticket_status
         if ($default) {
-            $ticket_status_class = ' tkt-status-' . EE_Ticket::onsale;
+            $ticket_status_class = ' tkt-status-'.EE_Ticket::onsale;
         } else {
             $ticket_status_class = $ticket->is_default()
-                ? ' tkt-status-' . EE_Ticket::onsale
-                : ' tkt-status-' . $ticket->ticket_status();
+                ? ' tkt-status-'.EE_Ticket::onsale
+                : ' tkt-status-'.$ticket->ticket_status();
         }
         //breaking out complicated condition for TKT_taxable
         if ($default) {
@@ -1482,7 +1482,7 @@ 
                 $TKT_min = '';
             }
         }
-        $template_args                 = array(
+        $template_args = array(
             'tkt_row'                       => $default ? 'TICKETNUM' : $ticket_row,
             'TKT_order'                     => $default ? 'TICKETNUM' : $ticket_row,
             //on initial page load this will always be the correct order.
@@ -1549,7 +1549,7 @@ 
                 : ' style="display:none;"',
             'show_price_mod_button'         => count($prices) > 1
                                                || ($default && $count_price_mods > 0)
-                                               || (! $default && $ticket->deleted())
+                                               || ( ! $default && $ticket->deleted())
                 ? ' style="display:none;"'
                 : '',
             'total_price_rows'              => count($prices) > 1 ? count($prices) : 1,
@@ -1591,7 +1591,7 @@ 
             //if empty then the start date will be now.
             $template_args['TKT_start_date']   = date($this->_date_time_format,
                 current_time('timestamp'));
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         if (empty($template_args['TKT_end_date'])) {
             //get the earliest datetime (if present);
@@ -1601,7 +1601,7 @@ 
                     array('order_by' => array('DTT_EVT_start' => 'ASC'))
                 )
                 : null;
-            if (! empty($earliest_dtt)) {
+            if ( ! empty($earliest_dtt)) {
                 $template_args['TKT_end_date'] = $earliest_dtt->get_datetime(
                     'DTT_EVT_start',
                     $this->_date_time_format
@@ -1615,10 +1615,10 @@ 
                     )
                 );
             }
-            $template_args['tkt_status_class'] = ' tkt-status-' . EE_Ticket::onsale;
+            $template_args['tkt_status_class'] = ' tkt-status-'.EE_Ticket::onsale;
         }
         //generate ticket_datetime items
-        if (! $default) {
+        if ( ! $default) {
             $datetime_row = 1;
             foreach ($all_datetimes as $datetime) {
                 $template_args['ticket_datetimes_list'] .= $this->_get_ticket_datetime_list_item(
@@ -1634,7 +1634,7 @@ 
         }
         $price_row = 1;
         foreach ($prices as $price) {
-            if (! $price instanceof EE_Price) {
+            if ( ! $price instanceof EE_Price) {
                 continue;
             }
             if ($price->is_base_price()) {
@@ -1667,7 +1667,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_row.template.php',
             $template_args,
             true
         );
@@ -1706,8 +1706,8 @@ 
                 $ticket,
                 $this->_is_creating_event
             );
-            $tax_rows      .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_tax_row.template.php',
+            $tax_rows .= EEH_Template::display_template(
+                PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_tax_row.template.php',
                 $template_args,
                 true
             );
@@ -1827,7 +1827,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_price_row.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_price_row.template.php',
             $template_args,
             true
         );
@@ -1897,7 +1897,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_type_base.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_type_base.template.php',
             $template_args,
             true
         );
@@ -1927,7 +1927,7 @@ 
     ) {
         $select_name = $default && ! $price instanceof EE_Price
             ? 'edit_prices[TICKETNUM][PRICENUM][PRT_ID]'
-            : 'edit_prices[' . $ticket_row . '][' . $price_row . '][PRT_ID]';
+            : 'edit_prices['.$ticket_row.']['.$price_row.'][PRT_ID]';
         /** @var EEM_Price_Type $price_type_model */
         $price_type_model       = EE_Registry::instance()->load_model('Price_Type');
         $price_types            = $price_type_model->get_all(array(
@@ -1945,23 +1945,23 @@ 
         $price_option_spans     = '';
         //setup price types for selector
         foreach ($price_types as $price_type) {
-            if (! $price_type instanceof EE_Price_Type) {
+            if ( ! $price_type instanceof EE_Price_Type) {
                 continue;
             }
-            $all_price_types[ $price_type->ID() ] = $price_type->get('PRT_name');
+            $all_price_types[$price_type->ID()] = $price_type->get('PRT_name');
             //while we're in the loop let's setup the option spans used by js
-            $span_args          = array(
+            $span_args = array(
                 'PRT_ID'         => $price_type->ID(),
                 'PRT_operator'   => $price_type->is_discount() ? '-' : '+',
                 'PRT_is_percent' => $price_type->get('PRT_is_percent') ? 1 : 0,
             );
             $price_option_spans .= EEH_Template::display_template(
-                PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_option_span.template.php',
+                PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_option_span.template.php',
                 $span_args,
                 true
             );
         }
-        $select_name               = $disabled ? 'archive_price[' . $ticket_row . '][' . $price_row . '][PRT_ID]'
+        $select_name               = $disabled ? 'archive_price['.$ticket_row.']['.$price_row.'][PRT_ID]'
             : $select_name;
         $select_input              = new EE_Select_Input(
             $all_price_types,
@@ -1987,7 +1987,7 @@ 
             'price_selected_is_percent' => $price_selected_is_percent,
             'disabled'                  => $disabled,
         );
-        $template_args             = apply_filters(
+        $template_args = apply_filters(
             'FHEE__espresso_events_Pricing_Hooks___get_price_modifier_template__template_args',
             $template_args,
             $ticket_row,
@@ -1998,7 +1998,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_price_modifier_selector.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_price_modifier_selector.template.php',
             $template_args,
             true
         );
@@ -2024,8 +2024,8 @@ 
         $ticket_datetimes = array(),
         $default
     ) {
-        $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[ $ticket->ID() ])
-            ? $ticket_datetimes[ $ticket->ID() ]
+        $tkt_datetimes = $ticket instanceof EE_Ticket && isset($ticket_datetimes[$ticket->ID()])
+            ? $ticket_datetimes[$ticket->ID()]
             : array();
         $template_args = array(
             'dtt_row'                  => $default && ! $datetime instanceof EE_Datetime
@@ -2057,7 +2057,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_datetimes_list_item.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_datetimes_list_item.template.php',
             $template_args,
             true
         );
@@ -2134,7 +2134,7 @@ 
                 true
             ),
         );
-        $ticket_row    = 1;
+        $ticket_row = 1;
         foreach ($all_tickets as $ticket) {
             $template_args['existing_available_datetime_tickets_list'] .= $this->_get_datetime_tickets_list_item(
                 'DTTNUM',
@@ -2163,11 +2163,11 @@ 
         $default_prices = $price_model->get_all_default_prices();
         $price_row      = 1;
         foreach ($default_prices as $price) {
-            if (! $price instanceof EE_Price) {
+            if ( ! $price instanceof EE_Price) {
                 continue;
             }
             if ($price->is_base_price()) {
-                $template_args['default_base_price_amount']      = $price->get_pretty(
+                $template_args['default_base_price_amount'] = $price->get_pretty(
                     'PRC_amount',
                     'localized_float'
                 );
@@ -2200,7 +2200,7 @@ 
             $this->_is_creating_event
         );
         return EEH_Template::display_template(
-            PRICING_TEMPLATE_PATH . 'event_tickets_datetime_ticket_js_structure.template.php',
+            PRICING_TEMPLATE_PATH.'event_tickets_datetime_ticket_js_structure.template.php',
             $template_args,
             true
         );

core/db_classes/EE_Datetime.class.php

Doc Comments +2 added lines, -2 removed lines

@@ -578,7 +578,7 @@ 
      * @param string $dt_frmt     string representation of date format defaults to WP settings
      * @param string $conjunction conjunction junction what's your function ?
      *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
+     * @return string              string on success, FALSE on fail
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -686,7 +686,7 @@ 
      * @param string $tm_format   string representation of time format defaults to 'g:i a'
      * @param string $conjunction conjunction junction what's your function ?
      *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
+     * @return string              string on success, FALSE on fail
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException

Indentation +1270 added lines, -1270 removed lines

@@ -14,1276 +14,1276 @@
 class EE_Datetime extends EE_Soft_Delete_Base_Class
 {
 
-    /**
-     * constant used by get_active_status, indicates datetime has no more available spaces
-     */
-    const sold_out = 'DTS';
-
-    /**
-     * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
-     */
-    const active = 'DTA';
-
-    /**
-     * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
-     * expired
-     */
-    const upcoming = 'DTU';
-
-    /**
-     * Datetime is postponed
-     */
-    const postponed = 'DTP';
-
-    /**
-     * Datetime is cancelled
-     */
-    const cancelled = 'DTC';
-
-    /**
-     * constant used by get_active_status, indicates datetime has expired (event is over)
-     */
-    const expired = 'DTE';
-
-    /**
-     * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
-     */
-    const inactive = 'DTI';
-
-
-    /**
-     * @param array  $props_n_values    incoming values
-     * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
-     * @param array $date_formats       incoming date_formats in an array where the first value is the date_format
-     *                                  and the second value is the time format
-     * @return EE_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
-    {
-        $has_object = parent::_check_for_object(
-            $props_n_values,
-            __CLASS__,
-            $timezone,
-            $date_formats
-        );
-        return $has_object
-            ? $has_object
-            : new self($props_n_values, false, $timezone, $date_formats);
-    }
-
-
-    /**
-     * @param array  $props_n_values  incoming values from the database
-     * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
-     *                                the website will be used.
-     * @return EE_Datetime
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public static function new_instance_from_db($props_n_values = array(), $timezone = null)
-    {
-        return new self($props_n_values, true, $timezone);
-    }
-
-
-    /**
-     * @param $name
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_name($name)
-    {
-        $this->set('DTT_name', $name);
-    }
-
-
-    /**
-     * @param $description
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_description($description)
-    {
-        $this->set('DTT_description', $description);
-    }
-
-
-    /**
-     * Set event start date
-     * set the start date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event start time
-     * set the start time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_start_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_start');
-    }
-
-
-    /**
-     * Set event end date
-     * set the end date for an event
-     *
-     * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_date($date)
-    {
-        $this->_set_date_for($date, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set event end time
-     * set the end time for an event
-     *
-     * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_end_time($time)
-    {
-        $this->_set_time_for($time, 'DTT_EVT_end');
-    }
-
-
-    /**
-     * Set registration limit
-     * set the maximum number of attendees that can be registered for this datetime slot
-     *
-     * @param int $reg_limit
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reg_limit($reg_limit)
-    {
-        $this->set('DTT_reg_limit', $reg_limit);
-    }
-
-
-    /**
-     * get the number of tickets sold for this datetime slot
-     *
-     * @return mixed int on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold()
-    {
-        return $this->get_raw('DTT_sold');
-    }
-
-
-    /**
-     * @param int $sold
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_sold($sold)
-    {
-        // sold can not go below zero
-        $sold = max(0, $sold);
-        $this->set('DTT_sold', $sold);
-    }
-
-
-    /**
-     * increments sold by amount passed by $qty
-     *
-     * @param int $qty
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_sold($qty = 1)
-    {
-        $sold = $this->sold() + $qty;
-        // remove ticket reservation
-        $this->decrease_reserved($qty);
-        $this->set_sold($sold);
-        do_action(
-            'AHEE__EE_Datetime__increase_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-    /**
-     * decrements (subtracts) sold amount passed by $qty
-     *
-     * @param int $qty
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_sold($qty = 1)
-    {
-        $sold = $this->sold() - $qty;
-        $this->set_sold($sold);
-        do_action(
-            'AHEE__EE_Datetime__decrease_sold',
-            $this,
-            $qty,
-            $sold
-        );
-    }
-
-
-    /**
-     * Gets qty of reserved tickets for this datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reserved()
-    {
-        return $this->get_raw('DTT_reserved');
-    }
-
-
-    /**
-     * Sets qty of reserved tickets for this datetime
-     *
-     * @param int $reserved
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_reserved($reserved)
-    {
-        // reserved can not go below zero
-        $reserved = max(0, (int) $reserved);
-        $this->set('DTT_reserved', $reserved);
-    }
-
-
-    /**
-     * increments reserved by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function increase_reserved($qty = 1)
-    {
-        $reserved = $this->reserved() + absint($qty);
-        do_action(
-            'AHEE__EE_Datetime__increase_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-        $this->set_reserved($reserved);
-    }
-
-
-    /**
-     * decrements (subtracts) reserved by amount passed by $qty
-     *
-     * @param int $qty
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function decrease_reserved($qty = 1)
-    {
-        $reserved = $this->reserved() - absint($qty);
-        do_action(
-            'AHEE__EE_Datetime__decrease_reserved',
-            $this,
-            $qty,
-            $reserved
-        );
-        $this->set_reserved($reserved);
-    }
-
-
-    /**
-     * total sold and reserved tickets
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_and_reserved()
-    {
-        return $this->sold() + $this->reserved();
-    }
-
-
-    /**
-     * returns the datetime name
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        return $this->get('DTT_name');
-    }
-
-
-    /**
-     * returns the datetime description
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function description()
-    {
-        return $this->get('DTT_description');
-    }
-
-
-    /**
-     * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
-     *
-     * @return boolean  TRUE if is primary, FALSE if not.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_primary()
-    {
-        return $this->get('DTT_is_primary');
-    }
-
-
-    /**
-     * This helper simply returns the order for the datetime
-     *
-     * @return int  The order of the datetime for this event.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function order()
-    {
-        return $this->get('DTT_order');
-    }
-
-
-    /**
-     * This helper simply returns the parent id for the datetime
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function parent()
-    {
-        return $this->get('DTT_parent');
-    }
-
-
-    /**
-     * show date and/or time
-     *
-     * @param string $date_or_time    whether to display a date or time or both
-     * @param string $start_or_end    whether to display start or end datetimes
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
-     *                                otherwise we use the standard formats)
-     * @return string|bool  string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    private function _show_datetime(
-        $date_or_time = null,
-        $start_or_end = 'start',
-        $dt_frmt = '',
-        $tm_frmt = '',
-        $echo = false
-    ) {
-        $field_name = "DTT_EVT_{$start_or_end}";
-        $dtt        = $this->_get_datetime(
-            $field_name,
-            $dt_frmt,
-            $tm_frmt,
-            $date_or_time,
-            $echo
-        );
-        if (! $echo) {
-            return $dtt;
-        }
-        return '';
-    }
-
-
-    /**
-     * get event start date.  Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt   string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'start', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes start_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'start', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get end date. Provide either the date format, or NULL to re-use the
-     * last-used format, or '' to use the default date format
-     *
-     * @param string $dt_frmt   string representation of date format defaults to 'F j, Y'
-     * @return mixed            string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date($dt_frmt = '')
-    {
-        return $this->_show_datetime('D', 'end', $dt_frmt);
-    }
-
-
-    /**
-     * Echoes the end date. See end_date()
-     *
-     * @param string $dt_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date($dt_frmt = '')
-    {
-        $this->_show_datetime('D', 'end', $dt_frmt, null, true);
-    }
-
-
-    /**
-     * get date_range - meaning the start AND end date
-     *
-     * @access public
-     * @param string $dt_frmt     string representation of date format defaults to WP settings
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        $dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
-        $start   = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
-        );
-        $end     = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_range($dt_frmt = '', $conjunction = ' - ')
-    {
-        echo $this->date_range($dt_frmt, $conjunction);
-    }
-
-
-    /**
-     * get start time
-     *
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return mixed        string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'start', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'start', null, $tm_format, true);
-    }
-
-
-    /**
-     * get end time
-     *
-     * @param string $tm_format     string representation of time format defaults to 'g:i a'
-     * @return mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_time($tm_format = '')
-    {
-        return $this->_show_datetime('T', 'end', null, $tm_format);
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_time($tm_format = '')
-    {
-        $this->_show_datetime('T', 'end', null, $tm_format, true);
-    }
-
-
-    /**
-     * get time_range
-     *
-     * @access public
-     * @param string $tm_format   string representation of time format defaults to 'g:i a'
-     * @param string $conjunction conjunction junction what's your function ?
-     *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
-     * @return mixed              string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function time_range($tm_format = '', $conjunction = ' - ')
-    {
-        $tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $start     = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_start', $tm_format)
-        );
-        $end       = str_replace(
-            ' ',
-            ' ',
-            $this->get_i18n_datetime('DTT_EVT_end', $tm_format)
-        );
-        return $start !== $end ? $start . $conjunction . $end : $start;
-    }
-
-
-    /**
-     * @param string $tm_format
-     * @param string $conjunction
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_time_range($tm_format = '', $conjunction = ' - ')
-    {
-        echo $this->time_range($tm_format, $conjunction);
-    }
-
-
-    /**
-     * This returns a range representation of the date and times.
-     * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
-     * Also, the return value is localized.
-     *
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction used between two different dates or times.
-     *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
-     * @param string $separator   used between the date and time formats.
-     *                            ex: Dec 1, 2016{$separator}2pm
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function date_and_time_range(
-        $dt_format = '',
-        $tm_format = '',
-        $conjunction = ' - ',
-        $separator = ' '
-    ) {
-        $dt_format   = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
-        $tm_format   = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $full_format = $dt_format . $separator . $tm_format;
-        //the range output depends on various conditions
-        switch (true) {
-            //start date timestamp and end date timestamp are the same.
-            case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')) :
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
-                break;
-            //start and end date are the same but times are different
-            case ($this->start_date() === $this->end_date()) :
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
-                break;
-            //all other conditions
-            default :
-                $output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
-                          . $conjunction
-                          . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
-                break;
-        }
-        return $output;
-    }
-
-
-    /**
-     * This echos the results of date and time range.
-     *
-     * @see date_and_time_range() for more details on purpose.
-     * @param string $dt_format
-     * @param string $tm_format
-     * @param string $conjunction
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
-    {
-        echo $this->date_and_time_range($dt_format, $tm_format, $conjunction);
-    }
-
-
-    /**
-     * get start date and start time
-     *
-     * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
-     * @param    string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed    string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start_date_and_time($dt_format = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'start', $dt_format, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     * Shows the length of the event (start to end time).
-     * Can be shown in 'seconds','minutes','hours', or 'days'.
-     * By default, rounds up. (So if you use 'days', and then event
-     * only occurs for 1 hour, it will return 1 day).
-     *
-     * @param string $units 'seconds','minutes','hours','days'
-     * @param bool   $round_up
-     * @return float|int|mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function length($units = 'seconds', $round_up = false)
-    {
-        $start           = $this->get_raw('DTT_EVT_start');
-        $end             = $this->get_raw('DTT_EVT_end');
-        $length_in_units = $end - $start;
-        switch ($units) {
-            //NOTE: We purposefully don't use "break;" in order to chain the divisions
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'days':
-                $length_in_units /= 24;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'hours':
-                $length_in_units /= 60;
-            /** @noinspection PhpMissingBreakStatementInspection */
-            case 'minutes':
-                $length_in_units /= 60;
-            case 'seconds':
-            default:
-                $length_in_units = ceil($length_in_units);
-        }
-        if ($round_up) {
-            $length_in_units = max($length_in_units, 1);
-        }
-        return $length_in_units;
-    }
-
-
-    /**
-     *        get end date and time
-     *
-     * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
-     * @param string $tm_format - string representation of time format defaults to 'g:i a'
-     * @return    mixed                string on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
-    }
-
-
-    /**
-     * @param string $dt_frmt
-     * @param string $tm_format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
-    {
-        $this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
-    }
-
-
-    /**
-     *        get start timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function start()
-    {
-        return $this->get_raw('DTT_EVT_start');
-    }
-
-
-    /**
-     *        get end timestamp
-     *
-     * @return        int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function end()
-    {
-        return $this->get_raw('DTT_EVT_end');
-    }
-
-
-    /**
-     *    get the registration limit for this datetime slot
-     *
-     * @return        mixed        int on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function reg_limit()
-    {
-        return $this->get_raw('DTT_reg_limit');
-    }
-
-
-    /**
-     *    have the tickets sold for this datetime, met or exceed the registration limit ?
-     *
-     * @return        boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sold_out()
-    {
-        return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
-    }
-
-
-    /**
-     * return the total number of spaces remaining at this venue.
-     * This only takes the venue's capacity into account, NOT the tickets available for sale
-     *
-     * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
-     *                               Because if all tickets attached to this datetime have no spaces left,
-     *                               then this datetime IS effectively sold out.
-     *                               However, there are cases where we just want to know the spaces
-     *                               remaining for this particular datetime, hence the flag.
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function spaces_remaining($consider_tickets = false)
-    {
-        // tickets remaining available for purchase
-        //no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
-        $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-        if (! $consider_tickets) {
-            return $dtt_remaining;
-        }
-        $tickets_remaining = $this->tickets_remaining();
-        return min($dtt_remaining, $tickets_remaining);
-    }
-
-
-    /**
-     * Counts the total tickets available
-     * (from all the different types of tickets which are available for this datetime).
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets_remaining($query_params = array())
-    {
-        $sum     = 0;
-        $tickets = $this->tickets($query_params);
-        if (! empty($tickets)) {
-            foreach ($tickets as $ticket) {
-                if ($ticket instanceof EE_Ticket) {
-                    // get the actual amount of tickets that can be sold
-                    $qty = $ticket->qty('saleable');
-                    if ($qty === EE_INF) {
-                        return EE_INF;
-                    }
-                    // no negative ticket quantities plz
-                    if ($qty > 0) {
-                        $sum += $qty;
-                    }
-                }
-            }
-        }
-        return $sum;
-    }
-
-
-    /**
-     * Gets the count of all the tickets available at this datetime (not ticket types)
-     * before any were sold
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sum_tickets_initially_available($query_params = array())
-    {
-        return $this->sum_related('Ticket', $query_params, 'TKT_qty');
-    }
-
-
-    /**
-     * Returns the lesser-of-the two: spaces remaining at this datetime, or
-     * the total tickets remaining (a sum of the tickets remaining for each ticket type
-     * that is available for this datetime).
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function total_tickets_available_at_this_datetime()
-    {
-        return $this->spaces_remaining(true);
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is upcoming or not.
-     *
-     * @access public
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_upcoming()
-    {
-        return ($this->get_raw('DTT_EVT_start') > time());
-    }
-
-
-    /**
-     * This simply compares the internal datetime for the given string with NOW
-     * and returns if the date is active (i.e. start and end time)
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_active()
-    {
-        return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
-    }
-
-
-    /**
-     * This simply compares the internal dtt for the given string with NOW
-     * and determines if the date is expired or not.
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function is_expired()
-    {
-        return ($this->get_raw('DTT_EVT_end') < time());
-    }
-
-
-    /**
-     * This returns the active status for whether an event is active, upcoming, or expired
-     *
-     * @return int return value will be one of the EE_Datetime status constants.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_active_status()
-    {
-        $total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
-        if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
-            return EE_Datetime::sold_out;
-        }
-        if ($this->is_expired()) {
-            return EE_Datetime::expired;
-        }
-        if ($this->is_upcoming()) {
-            return EE_Datetime::upcoming;
-        }
-        if ($this->is_active()) {
-            return EE_Datetime::active;
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
-     *
-     * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_dtt_display_name($use_dtt_name = false)
-    {
-        if ($use_dtt_name) {
-            $dtt_name = $this->name();
-            if (! empty($dtt_name)) {
-                return $dtt_name;
-            }
-        }
-        //first condition is to see if the months are different
-        if (
-            date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
-        ) {
-            $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
-            //next condition is if its the same month but different day
-        } else {
-            if (
-                date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
-                && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
-            ) {
-                $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
-            } else {
-                $display_date = $this->start_date('F j\, Y')
-                                . ' @ '
-                                . $this->start_date('g:i a')
-                                . ' - '
-                                . $this->end_date('g:i a');
-            }
-        }
-        return $display_date;
-    }
-
-
-    /**
-     * Gets all the tickets for this datetime
-     *
-     * @param array $query_params see EEM_Base::get_all()
-     * @return EE_Base_Class[]|EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function tickets($query_params = array())
-    {
-        return $this->get_many_related('Ticket', $query_params);
-    }
-
-
-    /**
-     * Gets all the ticket types currently available for purchase
-     *
-     * @param array $query_params like EEM_Base::get_all's
-     * @return EE_Ticket[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function ticket_types_available_for_purchase($query_params = array())
-    {
-        // first check if datetime is valid
-        if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
-            return array();
-        }
-        if (empty($query_params)) {
-            $query_params = array(
-                array(
-                    'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
-                    'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
-                    'TKT_deleted'    => false,
-                ),
-            );
-        }
-        return $this->tickets($query_params);
-    }
-
-
-    /**
-     * @return EE_Base_Class|EE_Event
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function event()
-    {
-        return $this->get_first_related('Event');
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
-     * (via the tickets). into account
-     *
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function update_sold()
-    {
-        $count_regs_for_this_datetime = EEM_Registration::instance()->count(
-            array(
-                array(
-                    'STS_ID'                 => EEM_Registration::status_id_approved,
-                    'REG_deleted'            => 0,
-                    'Ticket.Datetime.DTT_ID' => $this->ID(),
-                ),
-            )
-        );
-        $sold                         = $this->sold();
-        if ($count_regs_for_this_datetime > $sold) {
-            $this->increase_sold($count_regs_for_this_datetime - $sold);
-            $this->save();
-        } elseif ($count_regs_for_this_datetime < $sold) {
-            $this->decrease_sold($count_regs_for_this_datetime - $sold);
-            $this->save();
-        }
-        return $count_regs_for_this_datetime;
-    }
+	/**
+	 * constant used by get_active_status, indicates datetime has no more available spaces
+	 */
+	const sold_out = 'DTS';
+
+	/**
+	 * constant used by get_active_status, indicating datetime is still active (even is not over, can be registered-for)
+	 */
+	const active = 'DTA';
+
+	/**
+	 * constant used by get_active_status, indicating the datetime cannot be used for registrations yet, but has not
+	 * expired
+	 */
+	const upcoming = 'DTU';
+
+	/**
+	 * Datetime is postponed
+	 */
+	const postponed = 'DTP';
+
+	/**
+	 * Datetime is cancelled
+	 */
+	const cancelled = 'DTC';
+
+	/**
+	 * constant used by get_active_status, indicates datetime has expired (event is over)
+	 */
+	const expired = 'DTE';
+
+	/**
+	 * constant used in various places indicating that an event is INACTIVE (not yet ready to be published)
+	 */
+	const inactive = 'DTI';
+
+
+	/**
+	 * @param array  $props_n_values    incoming values
+	 * @param string $timezone          incoming timezone (if not set the timezone set for the website will be used.)
+	 * @param array $date_formats       incoming date_formats in an array where the first value is the date_format
+	 *                                  and the second value is the time format
+	 * @return EE_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance($props_n_values = array(), $timezone = null, $date_formats = array())
+	{
+		$has_object = parent::_check_for_object(
+			$props_n_values,
+			__CLASS__,
+			$timezone,
+			$date_formats
+		);
+		return $has_object
+			? $has_object
+			: new self($props_n_values, false, $timezone, $date_formats);
+	}
+
+
+	/**
+	 * @param array  $props_n_values  incoming values from the database
+	 * @param string $timezone        incoming timezone as set by the model.  If not set the timezone for
+	 *                                the website will be used.
+	 * @return EE_Datetime
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public static function new_instance_from_db($props_n_values = array(), $timezone = null)
+	{
+		return new self($props_n_values, true, $timezone);
+	}
+
+
+	/**
+	 * @param $name
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_name($name)
+	{
+		$this->set('DTT_name', $name);
+	}
+
+
+	/**
+	 * @param $description
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_description($description)
+	{
+		$this->set('DTT_description', $description);
+	}
+
+
+	/**
+	 * Set event start date
+	 * set the start date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event start time
+	 * set the start time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_start_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_start');
+	}
+
+
+	/**
+	 * Set event end date
+	 * set the end date for an event
+	 *
+	 * @param string $date a string representation of the event's date ex:  Dec. 25, 2025 or 12-25-2025
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_date($date)
+	{
+		$this->_set_date_for($date, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set event end time
+	 * set the end time for an event
+	 *
+	 * @param string $time a string representation of the event time ex:  9am  or  7:30 PM
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_end_time($time)
+	{
+		$this->_set_time_for($time, 'DTT_EVT_end');
+	}
+
+
+	/**
+	 * Set registration limit
+	 * set the maximum number of attendees that can be registered for this datetime slot
+	 *
+	 * @param int $reg_limit
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reg_limit($reg_limit)
+	{
+		$this->set('DTT_reg_limit', $reg_limit);
+	}
+
+
+	/**
+	 * get the number of tickets sold for this datetime slot
+	 *
+	 * @return mixed int on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold()
+	{
+		return $this->get_raw('DTT_sold');
+	}
+
+
+	/**
+	 * @param int $sold
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_sold($sold)
+	{
+		// sold can not go below zero
+		$sold = max(0, $sold);
+		$this->set('DTT_sold', $sold);
+	}
+
+
+	/**
+	 * increments sold by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_sold($qty = 1)
+	{
+		$sold = $this->sold() + $qty;
+		// remove ticket reservation
+		$this->decrease_reserved($qty);
+		$this->set_sold($sold);
+		do_action(
+			'AHEE__EE_Datetime__increase_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+	/**
+	 * decrements (subtracts) sold amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_sold($qty = 1)
+	{
+		$sold = $this->sold() - $qty;
+		$this->set_sold($sold);
+		do_action(
+			'AHEE__EE_Datetime__decrease_sold',
+			$this,
+			$qty,
+			$sold
+		);
+	}
+
+
+	/**
+	 * Gets qty of reserved tickets for this datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reserved()
+	{
+		return $this->get_raw('DTT_reserved');
+	}
+
+
+	/**
+	 * Sets qty of reserved tickets for this datetime
+	 *
+	 * @param int $reserved
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_reserved($reserved)
+	{
+		// reserved can not go below zero
+		$reserved = max(0, (int) $reserved);
+		$this->set('DTT_reserved', $reserved);
+	}
+
+
+	/**
+	 * increments reserved by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function increase_reserved($qty = 1)
+	{
+		$reserved = $this->reserved() + absint($qty);
+		do_action(
+			'AHEE__EE_Datetime__increase_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+		$this->set_reserved($reserved);
+	}
+
+
+	/**
+	 * decrements (subtracts) reserved by amount passed by $qty
+	 *
+	 * @param int $qty
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function decrease_reserved($qty = 1)
+	{
+		$reserved = $this->reserved() - absint($qty);
+		do_action(
+			'AHEE__EE_Datetime__decrease_reserved',
+			$this,
+			$qty,
+			$reserved
+		);
+		$this->set_reserved($reserved);
+	}
+
+
+	/**
+	 * total sold and reserved tickets
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_and_reserved()
+	{
+		return $this->sold() + $this->reserved();
+	}
+
+
+	/**
+	 * returns the datetime name
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		return $this->get('DTT_name');
+	}
+
+
+	/**
+	 * returns the datetime description
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function description()
+	{
+		return $this->get('DTT_description');
+	}
+
+
+	/**
+	 * This helper simply returns whether the event_datetime for the current datetime is a primary datetime
+	 *
+	 * @return boolean  TRUE if is primary, FALSE if not.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_primary()
+	{
+		return $this->get('DTT_is_primary');
+	}
+
+
+	/**
+	 * This helper simply returns the order for the datetime
+	 *
+	 * @return int  The order of the datetime for this event.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function order()
+	{
+		return $this->get('DTT_order');
+	}
+
+
+	/**
+	 * This helper simply returns the parent id for the datetime
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function parent()
+	{
+		return $this->get('DTT_parent');
+	}
+
+
+	/**
+	 * show date and/or time
+	 *
+	 * @param string $date_or_time    whether to display a date or time or both
+	 * @param string $start_or_end    whether to display start or end datetimes
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @param bool   $echo            whether we echo or return (note echoing uses "pretty" formats,
+	 *                                otherwise we use the standard formats)
+	 * @return string|bool  string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	private function _show_datetime(
+		$date_or_time = null,
+		$start_or_end = 'start',
+		$dt_frmt = '',
+		$tm_frmt = '',
+		$echo = false
+	) {
+		$field_name = "DTT_EVT_{$start_or_end}";
+		$dtt        = $this->_get_datetime(
+			$field_name,
+			$dt_frmt,
+			$tm_frmt,
+			$date_or_time,
+			$echo
+		);
+		if (! $echo) {
+			return $dtt;
+		}
+		return '';
+	}
+
+
+	/**
+	 * get event start date.  Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt   string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'start', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes start_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'start', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get end date. Provide either the date format, or NULL to re-use the
+	 * last-used format, or '' to use the default date format
+	 *
+	 * @param string $dt_frmt   string representation of date format defaults to 'F j, Y'
+	 * @return mixed            string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date($dt_frmt = '')
+	{
+		return $this->_show_datetime('D', 'end', $dt_frmt);
+	}
+
+
+	/**
+	 * Echoes the end date. See end_date()
+	 *
+	 * @param string $dt_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date($dt_frmt = '')
+	{
+		$this->_show_datetime('D', 'end', $dt_frmt, null, true);
+	}
+
+
+	/**
+	 * get date_range - meaning the start AND end date
+	 *
+	 * @access public
+	 * @param string $dt_frmt     string representation of date format defaults to WP settings
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		$dt_frmt = ! empty($dt_frmt) ? $dt_frmt : $this->_dt_frmt;
+		$start   = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
+		);
+		$end     = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_range($dt_frmt = '', $conjunction = ' - ')
+	{
+		echo $this->date_range($dt_frmt, $conjunction);
+	}
+
+
+	/**
+	 * get start time
+	 *
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return mixed        string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'start', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'start', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get end time
+	 *
+	 * @param string $tm_format     string representation of time format defaults to 'g:i a'
+	 * @return mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_time($tm_format = '')
+	{
+		return $this->_show_datetime('T', 'end', null, $tm_format);
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_time($tm_format = '')
+	{
+		$this->_show_datetime('T', 'end', null, $tm_format, true);
+	}
+
+
+	/**
+	 * get time_range
+	 *
+	 * @access public
+	 * @param string $tm_format   string representation of time format defaults to 'g:i a'
+	 * @param string $conjunction conjunction junction what's your function ?
+	 *                            this string joins the start date with the end date ie: Jan 01 "to" Dec 31
+	 * @return mixed              string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function time_range($tm_format = '', $conjunction = ' - ')
+	{
+		$tm_format = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$start     = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_start', $tm_format)
+		);
+		$end       = str_replace(
+			' ',
+			'&nbsp;',
+			$this->get_i18n_datetime('DTT_EVT_end', $tm_format)
+		);
+		return $start !== $end ? $start . $conjunction . $end : $start;
+	}
+
+
+	/**
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_time_range($tm_format = '', $conjunction = ' - ')
+	{
+		echo $this->time_range($tm_format, $conjunction);
+	}
+
+
+	/**
+	 * This returns a range representation of the date and times.
+	 * Output is dependent on the difference (or similarity) between DTT_EVT_start and DTT_EVT_end.
+	 * Also, the return value is localized.
+	 *
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction used between two different dates or times.
+	 *                            ex: Dec 1{$conjunction}}Dec 6, or 2pm{$conjunction}3pm
+	 * @param string $separator   used between the date and time formats.
+	 *                            ex: Dec 1, 2016{$separator}2pm
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function date_and_time_range(
+		$dt_format = '',
+		$tm_format = '',
+		$conjunction = ' - ',
+		$separator = ' '
+	) {
+		$dt_format   = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
+		$tm_format   = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
+		$full_format = $dt_format . $separator . $tm_format;
+		//the range output depends on various conditions
+		switch (true) {
+			//start date timestamp and end date timestamp are the same.
+			case ($this->get_raw('DTT_EVT_start') === $this->get_raw('DTT_EVT_end')) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format);
+				break;
+			//start and end date are the same but times are different
+			case ($this->start_date() === $this->end_date()) :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $tm_format);
+				break;
+			//all other conditions
+			default :
+				$output = $this->get_i18n_datetime('DTT_EVT_start', $full_format)
+						  . $conjunction
+						  . $this->get_i18n_datetime('DTT_EVT_end', $full_format);
+				break;
+		}
+		return $output;
+	}
+
+
+	/**
+	 * This echos the results of date and time range.
+	 *
+	 * @see date_and_time_range() for more details on purpose.
+	 * @param string $dt_format
+	 * @param string $tm_format
+	 * @param string $conjunction
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date_and_time_range($dt_format = '', $tm_format = '', $conjunction = ' - ')
+	{
+		echo $this->date_and_time_range($dt_format, $tm_format, $conjunction);
+	}
+
+
+	/**
+	 * get start date and start time
+	 *
+	 * @param    string $dt_format - string representation of date format defaults to 'F j, Y'
+	 * @param    string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed    string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start_date_and_time($dt_format = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'start', $dt_format, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_start_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'start', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 * Shows the length of the event (start to end time).
+	 * Can be shown in 'seconds','minutes','hours', or 'days'.
+	 * By default, rounds up. (So if you use 'days', and then event
+	 * only occurs for 1 hour, it will return 1 day).
+	 *
+	 * @param string $units 'seconds','minutes','hours','days'
+	 * @param bool   $round_up
+	 * @return float|int|mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function length($units = 'seconds', $round_up = false)
+	{
+		$start           = $this->get_raw('DTT_EVT_start');
+		$end             = $this->get_raw('DTT_EVT_end');
+		$length_in_units = $end - $start;
+		switch ($units) {
+			//NOTE: We purposefully don't use "break;" in order to chain the divisions
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'days':
+				$length_in_units /= 24;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'hours':
+				$length_in_units /= 60;
+			/** @noinspection PhpMissingBreakStatementInspection */
+			case 'minutes':
+				$length_in_units /= 60;
+			case 'seconds':
+			default:
+				$length_in_units = ceil($length_in_units);
+		}
+		if ($round_up) {
+			$length_in_units = max($length_in_units, 1);
+		}
+		return $length_in_units;
+	}
+
+
+	/**
+	 *        get end date and time
+	 *
+	 * @param string $dt_frmt   - string representation of date format defaults to 'F j, Y'
+	 * @param string $tm_format - string representation of time format defaults to 'g:i a'
+	 * @return    mixed                string on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		return $this->_show_datetime('', 'end', $dt_frmt, $tm_format);
+	}
+
+
+	/**
+	 * @param string $dt_frmt
+	 * @param string $tm_format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_end_date_and_time($dt_frmt = '', $tm_format = '')
+	{
+		$this->_show_datetime('', 'end', $dt_frmt, $tm_format, true);
+	}
+
+
+	/**
+	 *        get start timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function start()
+	{
+		return $this->get_raw('DTT_EVT_start');
+	}
+
+
+	/**
+	 *        get end timestamp
+	 *
+	 * @return        int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function end()
+	{
+		return $this->get_raw('DTT_EVT_end');
+	}
+
+
+	/**
+	 *    get the registration limit for this datetime slot
+	 *
+	 * @return        mixed        int on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function reg_limit()
+	{
+		return $this->get_raw('DTT_reg_limit');
+	}
+
+
+	/**
+	 *    have the tickets sold for this datetime, met or exceed the registration limit ?
+	 *
+	 * @return        boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sold_out()
+	{
+		return $this->reg_limit() > 0 && $this->sold() >= $this->reg_limit();
+	}
+
+
+	/**
+	 * return the total number of spaces remaining at this venue.
+	 * This only takes the venue's capacity into account, NOT the tickets available for sale
+	 *
+	 * @param bool $consider_tickets Whether to consider tickets remaining when determining if there are any spaces left
+	 *                               Because if all tickets attached to this datetime have no spaces left,
+	 *                               then this datetime IS effectively sold out.
+	 *                               However, there are cases where we just want to know the spaces
+	 *                               remaining for this particular datetime, hence the flag.
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function spaces_remaining($consider_tickets = false)
+	{
+		// tickets remaining available for purchase
+		//no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
+		$dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
+		if (! $consider_tickets) {
+			return $dtt_remaining;
+		}
+		$tickets_remaining = $this->tickets_remaining();
+		return min($dtt_remaining, $tickets_remaining);
+	}
+
+
+	/**
+	 * Counts the total tickets available
+	 * (from all the different types of tickets which are available for this datetime).
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets_remaining($query_params = array())
+	{
+		$sum     = 0;
+		$tickets = $this->tickets($query_params);
+		if (! empty($tickets)) {
+			foreach ($tickets as $ticket) {
+				if ($ticket instanceof EE_Ticket) {
+					// get the actual amount of tickets that can be sold
+					$qty = $ticket->qty('saleable');
+					if ($qty === EE_INF) {
+						return EE_INF;
+					}
+					// no negative ticket quantities plz
+					if ($qty > 0) {
+						$sum += $qty;
+					}
+				}
+			}
+		}
+		return $sum;
+	}
+
+
+	/**
+	 * Gets the count of all the tickets available at this datetime (not ticket types)
+	 * before any were sold
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sum_tickets_initially_available($query_params = array())
+	{
+		return $this->sum_related('Ticket', $query_params, 'TKT_qty');
+	}
+
+
+	/**
+	 * Returns the lesser-of-the two: spaces remaining at this datetime, or
+	 * the total tickets remaining (a sum of the tickets remaining for each ticket type
+	 * that is available for this datetime).
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function total_tickets_available_at_this_datetime()
+	{
+		return $this->spaces_remaining(true);
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is upcoming or not.
+	 *
+	 * @access public
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_upcoming()
+	{
+		return ($this->get_raw('DTT_EVT_start') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal datetime for the given string with NOW
+	 * and returns if the date is active (i.e. start and end time)
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_active()
+	{
+		return ($this->get_raw('DTT_EVT_start') < time() && $this->get_raw('DTT_EVT_end') > time());
+	}
+
+
+	/**
+	 * This simply compares the internal dtt for the given string with NOW
+	 * and determines if the date is expired or not.
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function is_expired()
+	{
+		return ($this->get_raw('DTT_EVT_end') < time());
+	}
+
+
+	/**
+	 * This returns the active status for whether an event is active, upcoming, or expired
+	 *
+	 * @return int return value will be one of the EE_Datetime status constants.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_active_status()
+	{
+		$total_tickets_for_this_dtt = $this->total_tickets_available_at_this_datetime();
+		if ($total_tickets_for_this_dtt !== false && $total_tickets_for_this_dtt < 1) {
+			return EE_Datetime::sold_out;
+		}
+		if ($this->is_expired()) {
+			return EE_Datetime::expired;
+		}
+		if ($this->is_upcoming()) {
+			return EE_Datetime::upcoming;
+		}
+		if ($this->is_active()) {
+			return EE_Datetime::active;
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a nice display name for the datetime that is contingent on the span between the dates and times.
+	 *
+	 * @param  boolean $use_dtt_name if TRUE then we'll use DTT->name() if its not empty.
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_dtt_display_name($use_dtt_name = false)
+	{
+		if ($use_dtt_name) {
+			$dtt_name = $this->name();
+			if (! empty($dtt_name)) {
+				return $dtt_name;
+			}
+		}
+		//first condition is to see if the months are different
+		if (
+			date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
+		) {
+			$display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
+			//next condition is if its the same month but different day
+		} else {
+			if (
+				date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
+				&& date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
+			) {
+				$display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
+			} else {
+				$display_date = $this->start_date('F j\, Y')
+								. ' @ '
+								. $this->start_date('g:i a')
+								. ' - '
+								. $this->end_date('g:i a');
+			}
+		}
+		return $display_date;
+	}
+
+
+	/**
+	 * Gets all the tickets for this datetime
+	 *
+	 * @param array $query_params see EEM_Base::get_all()
+	 * @return EE_Base_Class[]|EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function tickets($query_params = array())
+	{
+		return $this->get_many_related('Ticket', $query_params);
+	}
+
+
+	/**
+	 * Gets all the ticket types currently available for purchase
+	 *
+	 * @param array $query_params like EEM_Base::get_all's
+	 * @return EE_Ticket[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function ticket_types_available_for_purchase($query_params = array())
+	{
+		// first check if datetime is valid
+		if ($this->sold_out() || ! ($this->is_upcoming() || $this->is_active())) {
+			return array();
+		}
+		if (empty($query_params)) {
+			$query_params = array(
+				array(
+					'TKT_start_date' => array('<=', EEM_Ticket::instance()->current_time_for_query('TKT_start_date')),
+					'TKT_end_date'   => array('>=', EEM_Ticket::instance()->current_time_for_query('TKT_end_date')),
+					'TKT_deleted'    => false,
+				),
+			);
+		}
+		return $this->tickets($query_params);
+	}
+
+
+	/**
+	 * @return EE_Base_Class|EE_Event
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function event()
+	{
+		return $this->get_first_related('Event');
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute (and saves) based on the number of registrations for this datetime
+	 * (via the tickets). into account
+	 *
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function update_sold()
+	{
+		$count_regs_for_this_datetime = EEM_Registration::instance()->count(
+			array(
+				array(
+					'STS_ID'                 => EEM_Registration::status_id_approved,
+					'REG_deleted'            => 0,
+					'Ticket.Datetime.DTT_ID' => $this->ID(),
+				),
+			)
+		);
+		$sold                         = $this->sold();
+		if ($count_regs_for_this_datetime > $sold) {
+			$this->increase_sold($count_regs_for_this_datetime - $sold);
+			$this->save();
+		} elseif ($count_regs_for_this_datetime < $sold) {
+			$this->decrease_sold($count_regs_for_this_datetime - $sold);
+			$this->save();
+		}
+		return $count_regs_for_this_datetime;
+	}
 }
 
 /* End of file EE_Datetime.class.php */

Spacing +12 added lines, -12 removed lines

@@ -496,7 +496,7 @@ 
             $date_or_time,
             $echo
         );
-        if (! $echo) {
+        if ( ! $echo) {
             return $dtt;
         }
         return '';
@@ -593,12 +593,12 @@ 
             ' ',
             $this->get_i18n_datetime('DTT_EVT_start', $dt_frmt)
         );
-        $end     = str_replace(
+        $end = str_replace(
             ' ',
             ' ',
             $this->get_i18n_datetime('DTT_EVT_end', $dt_frmt)
         );
-        return $start !== $end ? $start . $conjunction . $end : $start;
+        return $start !== $end ? $start.$conjunction.$end : $start;
     }
 
 
@@ -701,12 +701,12 @@ 
             ' ',
             $this->get_i18n_datetime('DTT_EVT_start', $tm_format)
         );
-        $end       = str_replace(
+        $end = str_replace(
             ' ',
             ' ',
             $this->get_i18n_datetime('DTT_EVT_end', $tm_format)
         );
-        return $start !== $end ? $start . $conjunction . $end : $start;
+        return $start !== $end ? $start.$conjunction.$end : $start;
     }
 
 
@@ -751,7 +751,7 @@ 
     ) {
         $dt_format   = ! empty($dt_format) ? $dt_format : $this->_dt_frmt;
         $tm_format   = ! empty($tm_format) ? $tm_format : $this->_tm_frmt;
-        $full_format = $dt_format . $separator . $tm_format;
+        $full_format = $dt_format.$separator.$tm_format;
         //the range output depends on various conditions
         switch (true) {
             //start date timestamp and end date timestamp are the same.
@@ -988,7 +988,7 @@ 
         // tickets remaining available for purchase
         //no need for special checks for infinite, because if DTT_reg_limit == EE_INF, then EE_INF - x = EE_INF
         $dtt_remaining = $this->reg_limit() - $this->sold_and_reserved();
-        if (! $consider_tickets) {
+        if ( ! $consider_tickets) {
             return $dtt_remaining;
         }
         $tickets_remaining = $this->tickets_remaining();
@@ -1012,7 +1012,7 @@ 
     {
         $sum     = 0;
         $tickets = $this->tickets($query_params);
-        if (! empty($tickets)) {
+        if ( ! empty($tickets)) {
             foreach ($tickets as $ticket) {
                 if ($ticket instanceof EE_Ticket) {
                     // get the actual amount of tickets that can be sold
@@ -1163,7 +1163,7 @@ 
     {
         if ($use_dtt_name) {
             $dtt_name = $this->name();
-            if (! empty($dtt_name)) {
+            if ( ! empty($dtt_name)) {
                 return $dtt_name;
             }
         }
@@ -1171,14 +1171,14 @@ 
         if (
             date('m', $this->get_raw('DTT_EVT_start')) !== date('m', $this->get_raw('DTT_EVT_end'))
         ) {
-            $display_date = $this->start_date('M j\, Y g:i a') . ' - ' . $this->end_date('M j\, Y g:i a');
+            $display_date = $this->start_date('M j\, Y g:i a').' - '.$this->end_date('M j\, Y g:i a');
             //next condition is if its the same month but different day
         } else {
             if (
                 date('m', $this->get_raw('DTT_EVT_start')) === date('m', $this->get_raw('DTT_EVT_end'))
                 && date('d', $this->get_raw('DTT_EVT_start')) !== date('d', $this->get_raw('DTT_EVT_end'))
             ) {
-                $display_date = $this->start_date('M j\, g:i a') . ' - ' . $this->end_date('M j\, g:i a Y');
+                $display_date = $this->start_date('M j\, g:i a').' - '.$this->end_date('M j\, g:i a Y');
             } else {
                 $display_date = $this->start_date('F j\, Y')
                                 . ' @ '
@@ -1274,7 +1274,7 @@ 
                 ),
             )
         );
-        $sold                         = $this->sold();
+        $sold = $this->sold();
         if ($count_regs_for_this_datetime > $sold) {
             $this->increase_sold($count_regs_for_this_datetime - $sold);
             $this->save();

core/db_models/EEM_Datetime.model.php

Indentation +652 added lines, -652 removed lines

@@ -1,5 +1,5 @@ 
 <?php if (! defined('EVENT_ESPRESSO_VERSION')) {
-    exit('No direct script access allowed');
+	exit('No direct script access allowed');
 }
 
 
@@ -14,657 +14,657 @@ 
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
 
-    /**
-     * @var EEM_Datetime $_instance
-     */
-    protected static $_instance;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
-     *                         (and any incoming timezone data that gets saved).
-     *                         Note this just sends the timezone info to the date time model field objects.
-     *                         Default is NULL
-     *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    protected function __construct($timezone)
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = array(
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        );
-        $this->_fields                 = array(
-            'Datetime' => array(
-                'DTT_ID'          => new EE_Primary_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime ID', 'event_espresso')
-                ),
-                'EVT_ID'          => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'DTT_name'        => new EE_Plain_Text_Field(
-                    'DTT_name',
-                    esc_html__('Datetime Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_description' => new EE_Post_Content_Field(
-                    'DTT_description',
-                    esc_html__('Description for Datetime', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'DTT_EVT_start'   => new EE_Datetime_Field(
-                    'DTT_EVT_start',
-                    esc_html__('Start time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_EVT_end'     => new EE_Datetime_Field(
-                    'DTT_EVT_end',
-                    esc_html__('End time/date of Event', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
-                    'DTT_reg_limit',
-                    esc_html__('Registration Limit for this time', 'event_espresso'),
-                    true,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    true,
-                    0
-                ),
-                'DTT_reserved'    => new EE_Integer_Field(
-                    'DTT_reserved',
-                    esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_is_primary'  => new EE_Boolean_Field(
-                    'DTT_is_primary',
-                    esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'DTT_order'       => new EE_Integer_Field(
-                    'DTT_order',
-                    esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'DTT_parent'      => new EE_Integer_Field(
-                    'DTT_parent',
-                    esc_html__('Indicates what DTT_ID is the parent of this DTT_ID'),
-                    true,
-                    0
-                ),
-                'DTT_deleted'     => new EE_Trashed_Flag_Field(
-                    'DTT_deleted',
-                    esc_html__('Flag indicating datetime is archived', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ),
-        );
-        $this->_model_relations        = array(
-            'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'   => new EE_Belongs_To_Relation(),
-            'Checkin' => new EE_Has_Many_Relation(),
-        );
-        $this->_model_chain_to_wp_user = 'Event';
-        //this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            'Event',
-            EEM_Base::caps_edit
-        );
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * create new blank datetime
-     *
-     * @access public
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function create_new_blank_datetime()
-    {
-        //makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        $blank_datetime  = EE_Datetime::new_instance(
-            array(
-                'DTT_EVT_start' => $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS,
-                'DTT_EVT_end'   => $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF,
-            ),
-            $timezone_string
-        );
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                '8am',
-                'ga',
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                '5pm',
-                'ga',
-                $timezone_string
-            )
-        );
-        return array($blank_datetime);
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param  int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     */
-    public function get_all_event_dates($EVT_ID = 0)
-    {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
-            return $this->create_new_blank_datetime();
-        }
-        $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
-        if (empty($results)) {
-            return $this->create_new_blank_datetime();
-        }
-        return $results;
-    }
-
-
-    /**
-     * get all datetimes attached to an event ordered by the DTT_order field
-     *
-     * @public
-     * @param  int    $EVT_ID     event id
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param  int    $limit      If included then limit the count of results by
-     *                            the given number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_DTT_order(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Event.EVT_ID' => $EVT_ID);
-        $query_params = ! empty($limit)
-            ? array(
-                $where_params,
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-            : array(
-                $where_params,
-                'order_by'                 => array('DTT_order' => 'ASC'),
-                'default_where_conditions' => 'none',
-            );
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the datetimes for the event (with the given limit), and orders them by "importance".
-     * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
-     * and then the earlier datetimes are the most important.
-     * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
-     *
-     * @param int $EVT_ID
-     * @param int $limit
-     * @return EE_Datetime[]|EE_Base_Class[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
-    {
-        return $this->get_all(
-            array(
-                array('Event.EVT_ID' => $EVT_ID),
-                'limit'                    => $limit,
-                'order_by'                 => array('DTT_EVT_start' => 'ASC'),
-                'default_where_conditions' => 'none',
-            )
-        );
-    }
-
-
-    /**
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_start_time(
-            $EVT_ID,
-            $include_expired,
-            $include_deleted,
-            1
-        );
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * Gets the 'primary' datetime for an event.
-     *
-     * @param int  $EVT_ID
-     * @param bool $try_to_exclude_expired
-     * @param bool $try_to_exclude_deleted
-     * @return \EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_primary_datetime_for_event(
-        $EVT_ID,
-        $try_to_exclude_expired = true,
-        $try_to_exclude_deleted = true
-    ) {
-        if ($try_to_exclude_expired) {
-            $non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
-            if ($non_expired) {
-                return $non_expired;
-            }
-        }
-        if ($try_to_exclude_deleted) {
-            $expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
-            if ($expired_even) {
-                return $expired_even;
-            }
-        }
-        return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $EVT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_event_ordered_by_start_time(
-        $EVT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize EVT_ID
-        $EVT_ID         = absint($EVT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
-     * only by start date
-     *
-     * @param int     $TKT_ID
-     * @param boolean $include_expired
-     * @param boolean $include_deleted
-     * @param int     $limit
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_start_time(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize TKT_ID
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
-     * datetimes.
-     *
-     * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
-     * @param  boolean  $include_expired whether to include expired datetimes or not
-     * @param  boolean  $include_deleted whether to include trashed datetimes or not.
-     * @param  int|null $limit           if null, no limit, if int then limit results by
-     *                                   that number
-     * @return EE_Datetime[]
-     * @throws EE_Error
-     */
-    public function get_datetimes_for_ticket_ordered_by_DTT_order(
-        $TKT_ID,
-        $include_expired = true,
-        $include_deleted = true,
-        $limit = null
-    ) {
-        //sanitize id.
-        $TKT_ID         = absint($TKT_ID);
-        $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
-        $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
-        $where_params = array('Ticket.TKT_ID' => $TKT_ID);
-        $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
-            $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
-        }
-        if ($include_deleted) {
-            $query_params[0]['DTT_deleted'] = array('IN', array(true, false));
-        }
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        /** @var EE_Datetime[] $result */
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($old_assumption);
-        return $result;
-    }
-
-
-    /**
-     * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
-     * reason it doesn't exist, we consider the earliest event the most important)
-     *
-     * @param int $EVT_ID
-     * @return EE_Datetime
-     * @throws EE_Error
-     */
-    public function get_most_important_datetime_for_event($EVT_ID)
-    {
-        $results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
-        if ($results) {
-            return array_shift($results);
-        }
-        return null;
-    }
-
-
-    /**
-     * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
-     * grouped by month and year.
-     *
-     * @param  array  $where_params      Array of query_params as described in the comments for EEM_Base::get_all()
-     * @param  string $evt_active_status A string representing the evt active status to filter the months by.
-     *                                   Can be:
-     *                                   - '' = no filter
-     *                                   - upcoming = Published events with at least one upcoming datetime.
-     *                                   - expired = Events with all datetimes expired.
-     *                                   - active = Events that are published and have at least one datetime that
-     *                                   starts before now and ends after now.
-     *                                   - inactive = Events that are either not published.
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years($where_params, $evt_active_status = '')
-    {
-        $current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
-        $current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
-        switch ($evt_active_status) {
-            case 'upcoming' :
-                $where_params['Event.status'] = 'publish';
-                //if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
-                }
-                $where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
-                break;
-            case 'expired' :
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                //get events to exclude
-                $exclude_query[0] = array_merge($where_params,
-                    array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end)));
-                //first get all events that have datetimes where its not expired.
-                $event_ids = $this->_get_all_wpdb_results(
-                    $exclude_query,
-                    OBJECT_K,
-                    'Datetime.EVT_ID'
-                );
-                $event_ids = array_keys($event_ids);
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
-                $where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
-                break;
-            case 'active' :
-                $where_params['Event.status'] = 'publish';
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
-                }
-                if (isset($where_params['Datetime.DTT_EVT_end'])) {
-                    $where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
-                }
-                $where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
-                $where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
-                break;
-            case 'inactive' :
-                if (isset($where_params['Event.status'])) {
-                    unset($where_params['Event.status']);
-                }
-                if (isset($where_params['OR'])) {
-                    $where_params['AND']['OR'] = $where_params['OR'];
-                }
-                if (isset($where_params['DTT_EVT_end'])) {
-                    $where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
-                    unset($where_params['DTT_EVT_end']);
-                }
-                if (isset($where_params['DTT_EVT_start'])) {
-                    $where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
-                    unset($where_params['DTT_EVT_start']);
-                }
-                $where_params['AND']['Event.status'] = array('!=', 'publish');
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = array('dtt_year', 'dtt_month');
-        $query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
-        $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
-            'DTT_EVT_start');
-        $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
-        );
-        return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
-    }
-
-
-    /**
-     * Updates the DTT_sold attribute on each datetime (based on the registrations
-     * for the tickets for each datetime)
-     *
-     * @param EE_Base_Class[]|EE_Datetime[] $datetimes
-     * @throws EE_Error
-     */
-    public function update_sold($datetimes)
-    {
-        EE_Error::doing_it_wrong(
-            __FUNCTION__,
-            esc_html__(
-                'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
-                'event_espresso'
-            ),
-            '4.9.32.rc.005'
-        );
-        foreach ($datetimes as $datetime) {
-            $datetime->update_sold();
-        }
-    }
-
-
-    /**
-     *    Gets the total number of tickets available at a particular datetime
-     *    (does NOT take into account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
-     *             tickets attached to datetime then FALSE is returned.
-     */
-    public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
-    {
-        $datetime = $this->get_one_by_ID($DTT_ID);
-        if ($datetime instanceof EE_Datetime) {
-            return $datetime->tickets_remaining($query_params);
-        }
-        return 0;
-    }
-
-
-    /**
-     * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
-     *
-     * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
-     *                                 stati you want counts for as values in the array.  An empty array returns counts
-     *                                 for all valid stati.
-     * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
-     *                                 only for Datetimes connected to a specific event, or specific ticket.
-     * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
-     * @throws EE_Error
-     *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
-     *                                 EE_Datetime::expired
-     */
-    public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
-    {
-        //only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : array();
-        $status_query_args = array(
-            EE_Datetime::active   => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                array('DTT_EVT_start' => array('>', time()))
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                array('DTT_EVT_end' => array('<', time()))
-            ),
-        );
-        if (! empty($stati_to_include)) {
-            foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
-                }
-            }
-        }
-        //loop through and query counts for each stati.
-        $status_query_results = array();
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                array($status_where_conditions),
-                'DTT_ID',
-                true
-            );
-        }
-        return $status_query_results;
-    }
-
-
-    /**
-     * Returns the specific count for a given Datetime status matching any given query_params.
-     *
-     * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
-    {
-        $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
+	/**
+	 * @var EEM_Datetime $_instance
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $timezone A string representing the timezone we want to set for returned Date Time Strings
+	 *                         (and any incoming timezone data that gets saved).
+	 *                         Note this just sends the timezone info to the date time model field objects.
+	 *                         Default is NULL
+	 *                         (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	protected function __construct($timezone)
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = array(
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		);
+		$this->_fields                 = array(
+			'Datetime' => array(
+				'DTT_ID'          => new EE_Primary_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime ID', 'event_espresso')
+				),
+				'EVT_ID'          => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'DTT_name'        => new EE_Plain_Text_Field(
+					'DTT_name',
+					esc_html__('Datetime Name', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_description' => new EE_Post_Content_Field(
+					'DTT_description',
+					esc_html__('Description for Datetime', 'event_espresso'),
+					false,
+					''
+				),
+				'DTT_EVT_start'   => new EE_Datetime_Field(
+					'DTT_EVT_start',
+					esc_html__('Start time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_EVT_end'     => new EE_Datetime_Field(
+					'DTT_EVT_end',
+					esc_html__('End time/date of Event', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'DTT_reg_limit'   => new EE_Infinite_Integer_Field(
+					'DTT_reg_limit',
+					esc_html__('Registration Limit for this time', 'event_espresso'),
+					true,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					true,
+					0
+				),
+				'DTT_reserved'    => new EE_Integer_Field(
+					'DTT_reserved',
+					esc_html__('Quantity of tickets reserved, but not yet fully purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_is_primary'  => new EE_Boolean_Field(
+					'DTT_is_primary',
+					esc_html__('Flag indicating datetime is primary one for event', 'event_espresso'),
+					false,
+					false
+				),
+				'DTT_order'       => new EE_Integer_Field(
+					'DTT_order',
+					esc_html__('The order in which the Datetime is displayed', 'event_espresso'),
+					false,
+					0
+				),
+				'DTT_parent'      => new EE_Integer_Field(
+					'DTT_parent',
+					esc_html__('Indicates what DTT_ID is the parent of this DTT_ID'),
+					true,
+					0
+				),
+				'DTT_deleted'     => new EE_Trashed_Flag_Field(
+					'DTT_deleted',
+					esc_html__('Flag indicating datetime is archived', 'event_espresso'),
+					false,
+					false
+				),
+			),
+		);
+		$this->_model_relations        = array(
+			'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'   => new EE_Belongs_To_Relation(),
+			'Checkin' => new EE_Has_Many_Relation(),
+		);
+		$this->_model_chain_to_wp_user = 'Event';
+		//this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			'Event',
+			EEM_Base::caps_edit
+		);
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * create new blank datetime
+	 *
+	 * @access public
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function create_new_blank_datetime()
+	{
+		//makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		$blank_datetime  = EE_Datetime::new_instance(
+			array(
+				'DTT_EVT_start' => $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS,
+				'DTT_EVT_end'   => $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF,
+			),
+			$timezone_string
+		);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				'8am',
+				'ga',
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				'5pm',
+				'ga',
+				$timezone_string
+			)
+		);
+		return array($blank_datetime);
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param  int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 */
+	public function get_all_event_dates($EVT_ID = 0)
+	{
+		if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+			return $this->create_new_blank_datetime();
+		}
+		$results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
+		if (empty($results)) {
+			return $this->create_new_blank_datetime();
+		}
+		return $results;
+	}
+
+
+	/**
+	 * get all datetimes attached to an event ordered by the DTT_order field
+	 *
+	 * @public
+	 * @param  int    $EVT_ID     event id
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param  int    $limit      If included then limit the count of results by
+	 *                            the given number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_DTT_order(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Event.EVT_ID' => $EVT_ID);
+		$query_params = ! empty($limit)
+			? array(
+				$where_params,
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+			: array(
+				$where_params,
+				'order_by'                 => array('DTT_order' => 'ASC'),
+				'default_where_conditions' => 'none',
+			);
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the datetimes for the event (with the given limit), and orders them by "importance".
+	 * By importance, we mean that the primary datetimes are most important (DEPRECATED FOR NOW),
+	 * and then the earlier datetimes are the most important.
+	 * Maybe we'll want this to take into account datetimes that haven't already passed, but we don't yet.
+	 *
+	 * @param int $EVT_ID
+	 * @param int $limit
+	 * @return EE_Datetime[]|EE_Base_Class[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_importance($EVT_ID = 0, $limit = null)
+	{
+		return $this->get_all(
+			array(
+				array('Event.EVT_ID' => $EVT_ID),
+				'limit'                    => $limit,
+				'order_by'                 => array('DTT_EVT_start' => 'ASC'),
+				'default_where_conditions' => 'none',
+			)
+		);
+	}
+
+
+	/**
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_oldest_datetime_for_event($EVT_ID, $include_expired = false, $include_deleted = false)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_start_time(
+			$EVT_ID,
+			$include_expired,
+			$include_deleted,
+			1
+		);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * Gets the 'primary' datetime for an event.
+	 *
+	 * @param int  $EVT_ID
+	 * @param bool $try_to_exclude_expired
+	 * @param bool $try_to_exclude_deleted
+	 * @return \EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_primary_datetime_for_event(
+		$EVT_ID,
+		$try_to_exclude_expired = true,
+		$try_to_exclude_deleted = true
+	) {
+		if ($try_to_exclude_expired) {
+			$non_expired = $this->get_oldest_datetime_for_event($EVT_ID, false, false);
+			if ($non_expired) {
+				return $non_expired;
+			}
+		}
+		if ($try_to_exclude_deleted) {
+			$expired_even = $this->get_oldest_datetime_for_event($EVT_ID, true);
+			if ($expired_even) {
+				return $expired_even;
+			}
+		}
+		return $this->get_oldest_datetime_for_event($EVT_ID, true, true);
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an event (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_event_ordered_by_start_time(
+		$EVT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize EVT_ID
+		$EVT_ID         = absint($EVT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets ALL the datetimes for an ticket (including trashed ones, for now), ordered
+	 * only by start date
+	 *
+	 * @param int     $TKT_ID
+	 * @param boolean $include_expired
+	 * @param boolean $include_deleted
+	 * @param int     $limit
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_start_time(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize TKT_ID
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets all the datetimes for a ticket (including trashed ones, for now), ordered by the DTT_order for the
+	 * datetimes.
+	 *
+	 * @param  int      $TKT_ID          ID of ticket to retrieve the datetimes for
+	 * @param  boolean  $include_expired whether to include expired datetimes or not
+	 * @param  boolean  $include_deleted whether to include trashed datetimes or not.
+	 * @param  int|null $limit           if null, no limit, if int then limit results by
+	 *                                   that number
+	 * @return EE_Datetime[]
+	 * @throws EE_Error
+	 */
+	public function get_datetimes_for_ticket_ordered_by_DTT_order(
+		$TKT_ID,
+		$include_expired = true,
+		$include_deleted = true,
+		$limit = null
+	) {
+		//sanitize id.
+		$TKT_ID         = absint($TKT_ID);
+		$old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
+		$this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
+		$where_params = array('Ticket.TKT_ID' => $TKT_ID);
+		$query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
+		if (! $include_expired) {
+			$query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
+		}
+		if ($include_deleted) {
+			$query_params[0]['DTT_deleted'] = array('IN', array(true, false));
+		}
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		/** @var EE_Datetime[] $result */
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($old_assumption);
+		return $result;
+	}
+
+
+	/**
+	 * Gets the most important datetime for a particular event (ie, the primary event usually. But if for some WACK
+	 * reason it doesn't exist, we consider the earliest event the most important)
+	 *
+	 * @param int $EVT_ID
+	 * @return EE_Datetime
+	 * @throws EE_Error
+	 */
+	public function get_most_important_datetime_for_event($EVT_ID)
+	{
+		$results = $this->get_datetimes_for_event_ordered_by_importance($EVT_ID, 1);
+		if ($results) {
+			return array_shift($results);
+		}
+		return null;
+	}
+
+
+	/**
+	 * This returns a wpdb->results        Array of all DTT month and years matching the incoming query params and
+	 * grouped by month and year.
+	 *
+	 * @param  array  $where_params      Array of query_params as described in the comments for EEM_Base::get_all()
+	 * @param  string $evt_active_status A string representing the evt active status to filter the months by.
+	 *                                   Can be:
+	 *                                   - '' = no filter
+	 *                                   - upcoming = Published events with at least one upcoming datetime.
+	 *                                   - expired = Events with all datetimes expired.
+	 *                                   - active = Events that are published and have at least one datetime that
+	 *                                   starts before now and ends after now.
+	 *                                   - inactive = Events that are either not published.
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years($where_params, $evt_active_status = '')
+	{
+		$current_time_for_DTT_EVT_start = $this->current_time_for_query('DTT_EVT_start');
+		$current_time_for_DTT_EVT_end   = $this->current_time_for_query('DTT_EVT_end');
+		switch ($evt_active_status) {
+			case 'upcoming' :
+				$where_params['Event.status'] = 'publish';
+				//if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['DTT_EVT_start*****'] = $where_params['DTT_EVT_start'];
+				}
+				$where_params['DTT_EVT_start'] = array('>', $current_time_for_DTT_EVT_start);
+				break;
+			case 'expired' :
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				//get events to exclude
+				$exclude_query[0] = array_merge($where_params,
+					array('DTT_EVT_end' => array('>', $current_time_for_DTT_EVT_end)));
+				//first get all events that have datetimes where its not expired.
+				$event_ids = $this->_get_all_wpdb_results(
+					$exclude_query,
+					OBJECT_K,
+					'Datetime.EVT_ID'
+				);
+				$event_ids = array_keys($event_ids);
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_end']  = array('<', $current_time_for_DTT_EVT_end);
+				$where_params['Event.EVT_ID'] = array('NOT IN', $event_ids);
+				break;
+			case 'active' :
+				$where_params['Event.status'] = 'publish';
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['Datetime.DTT_EVT_start******'] = $where_params['DTT_EVT_start'];
+				}
+				if (isset($where_params['Datetime.DTT_EVT_end'])) {
+					$where_params['Datetime.DTT_EVT_end*****'] = $where_params['DTT_EVT_end'];
+				}
+				$where_params['DTT_EVT_start'] = array('<', $current_time_for_DTT_EVT_start);
+				$where_params['DTT_EVT_end']   = array('>', $current_time_for_DTT_EVT_end);
+				break;
+			case 'inactive' :
+				if (isset($where_params['Event.status'])) {
+					unset($where_params['Event.status']);
+				}
+				if (isset($where_params['OR'])) {
+					$where_params['AND']['OR'] = $where_params['OR'];
+				}
+				if (isset($where_params['DTT_EVT_end'])) {
+					$where_params['AND']['DTT_EVT_end****'] = $where_params['DTT_EVT_end'];
+					unset($where_params['DTT_EVT_end']);
+				}
+				if (isset($where_params['DTT_EVT_start'])) {
+					$where_params['AND']['DTT_EVT_start'] = $where_params['DTT_EVT_start'];
+					unset($where_params['DTT_EVT_start']);
+				}
+				$where_params['AND']['Event.status'] = array('!=', 'publish');
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = array('dtt_year', 'dtt_month');
+		$query_params['order_by'] = array('DTT_EVT_start' => 'DESC');
+		$query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
+			'DTT_EVT_start');
+		$columns_to_select        = array(
+			'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
+			'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
+			'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+		);
+		return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
+	}
+
+
+	/**
+	 * Updates the DTT_sold attribute on each datetime (based on the registrations
+	 * for the tickets for each datetime)
+	 *
+	 * @param EE_Base_Class[]|EE_Datetime[] $datetimes
+	 * @throws EE_Error
+	 */
+	public function update_sold($datetimes)
+	{
+		EE_Error::doing_it_wrong(
+			__FUNCTION__,
+			esc_html__(
+				'Please use \EEM_Ticket::update_tickets_sold() instead which will in turn correctly update both the Ticket AND Datetime counts.',
+				'event_espresso'
+			),
+			'4.9.32.rc.005'
+		);
+		foreach ($datetimes as $datetime) {
+			$datetime->update_sold();
+		}
+	}
+
+
+	/**
+	 *    Gets the total number of tickets available at a particular datetime
+	 *    (does NOT take into account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int of tickets available. If sold out, return less than 1. If infinite, returns EE_INF,  IF there are NO
+	 *             tickets attached to datetime then FALSE is returned.
+	 */
+	public function sum_tickets_currently_available_at_datetime($DTT_ID, array $query_params = array())
+	{
+		$datetime = $this->get_one_by_ID($DTT_ID);
+		if ($datetime instanceof EE_Datetime) {
+			return $datetime->tickets_remaining($query_params);
+		}
+		return 0;
+	}
+
+
+	/**
+	 * This returns an array of counts of datetimes in the database for each Datetime status that can be queried.
+	 *
+	 * @param  array $stati_to_include If included you can restrict the statuses we return counts for by including the
+	 *                                 stati you want counts for as values in the array.  An empty array returns counts
+	 *                                 for all valid stati.
+	 * @param  array $query_params     If included can be used to refine the conditions for returning the count (i.e.
+	 *                                 only for Datetimes connected to a specific event, or specific ticket.
+	 * @return array  The value returned is an array indexed by Datetime Status and the values are the counts.  The
+	 * @throws EE_Error
+	 *                                 stati used as index keys are: EE_Datetime::active EE_Datetime::upcoming
+	 *                                 EE_Datetime::expired
+	 */
+	public function get_datetime_counts_by_status(array $stati_to_include = array(), array $query_params = array())
+	{
+		//only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : array();
+		$status_query_args = array(
+			EE_Datetime::active   => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('<', time()), 'DTT_EVT_end' => array('>', time()))
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				array('DTT_EVT_start' => array('>', time()))
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				array('DTT_EVT_end' => array('<', time()))
+			),
+		);
+		if (! empty($stati_to_include)) {
+			foreach (array_keys($status_query_args) as $status) {
+				if (! in_array($status, $stati_to_include, true)) {
+					unset($status_query_args[ $status ]);
+				}
+			}
+		}
+		//loop through and query counts for each stati.
+		$status_query_results = array();
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				array($status_where_conditions),
+				'DTT_ID',
+				true
+			);
+		}
+		return $status_query_results;
+	}
+
+
+	/**
+	 * Returns the specific count for a given Datetime status matching any given query_params.
+	 *
+	 * @param string $status Valid string representation for Datetime status requested. (Defaults to Active).
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
+	{
+		$count = $this->get_datetime_counts_by_status(array($status), $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
 }
 // End of file EEM_Datetime.model.php
 // Location: /includes/models/EEM_Datetime.model.php

Spacing +19 added lines, -19 removed lines

@@ -1,4 +1,4 @@ 
-<?php if (! defined('EVENT_ESPRESSO_VERSION')) {
+<?php if ( ! defined('EVENT_ESPRESSO_VERSION')) {
     exit('No direct script access allowed');
 }
 
@@ -122,23 +122,23 @@ 
                 ),
             ),
         );
-        $this->_model_relations        = array(
+        $this->_model_relations = array(
             'Ticket'  => new EE_HABTM_Relation('Datetime_Ticket'),
             'Event'   => new EE_Belongs_To_Relation(),
             'Checkin' => new EE_Has_Many_Relation(),
         );
         $this->_model_chain_to_wp_user = 'Event';
         //this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public(
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       = new EE_Restriction_Generator_Event_Related_Public(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] = new EE_Restriction_Generator_Event_Related_Protected(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = new EE_Restriction_Generator_Event_Related_Protected(
             'Event'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = new EE_Restriction_Generator_Event_Related_Protected(
             'Event',
             EEM_Base::caps_edit
         );
@@ -196,7 +196,7 @@ 
      */
     public function get_all_event_dates($EVT_ID = 0)
     {
-        if (! $EVT_ID) { // on add_new_event event_id gets set to 0
+        if ( ! $EVT_ID) { // on add_new_event event_id gets set to 0
             return $this->create_new_blank_datetime();
         }
         $results = $this->get_datetimes_for_event_ordered_by_DTT_order($EVT_ID);
@@ -242,7 +242,7 @@ 
                 'order_by'                 => array('DTT_order' => 'ASC'),
                 'default_where_conditions' => 'none',
             );
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -353,7 +353,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Event.EVT_ID' => $EVT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -391,7 +391,7 @@ 
         $old_assumption = $this->get_assumption_concerning_values_already_prepared_by_model_object();
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $query_params = array(array('Ticket.TKT_ID' => $TKT_ID), 'order_by' => array('DTT_EVT_start' => 'asc'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -431,7 +431,7 @@ 
         $this->assume_values_already_prepared_by_model_object(EEM_Base::prepared_for_use_in_db);
         $where_params = array('Ticket.TKT_ID' => $TKT_ID);
         $query_params = array($where_params, 'order_by' => array('DTT_order' => 'ASC'));
-        if (! $include_expired) {
+        if ( ! $include_expired) {
             $query_params[0]['DTT_EVT_end'] = array('>=', current_time('mysql', true));
         }
         if ($include_deleted) {
@@ -551,9 +551,9 @@ 
         $query_interval           = EEH_DTT_Helper::get_sql_query_interval_for_offset($this->get_timezone(),
             'DTT_EVT_start');
         $columns_to_select        = array(
-            'dtt_year'      => array('YEAR(' . $query_interval . ')', '%s'),
-            'dtt_month'     => array('MONTHNAME(' . $query_interval . ')', '%s'),
-            'dtt_month_num' => array('MONTH(' . $query_interval . ')', '%s'),
+            'dtt_year'      => array('YEAR('.$query_interval.')', '%s'),
+            'dtt_month'     => array('MONTHNAME('.$query_interval.')', '%s'),
+            'dtt_month_num' => array('MONTH('.$query_interval.')', '%s'),
         );
         return $this->_get_all_wpdb_results($query_params, OBJECT, $columns_to_select);
     }
@@ -632,17 +632,17 @@ 
                 array('DTT_EVT_end' => array('<', time()))
             ),
         );
-        if (! empty($stati_to_include)) {
+        if ( ! empty($stati_to_include)) {
             foreach (array_keys($status_query_args) as $status) {
-                if (! in_array($status, $stati_to_include, true)) {
-                    unset($status_query_args[ $status ]);
+                if ( ! in_array($status, $stati_to_include, true)) {
+                    unset($status_query_args[$status]);
                 }
             }
         }
         //loop through and query counts for each stati.
         $status_query_results = array();
         foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
+            $status_query_results[$status] = EEM_Datetime::count(
                 array($status_where_conditions),
                 'DTT_ID',
                 true
@@ -663,7 +663,7 @@ 
     public function get_datetime_count_for_status($status = EE_Datetime::active, array $query_params = array())
     {
         $count = $this->get_datetime_counts_by_status(array($status), $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+        return ! empty($count[$status]) ? $count[$status] : 0;
     }
 }
 // End of file EEM_Datetime.model.php

core/db_classes/EE_Base_Class.class.php

Indentation +3125 added lines, -3125 removed lines

@@ -15,3131 +15,3131 @@
 abstract class EE_Base_Class
 {
 
-    /**
-     * This is an array of the original properties and values provided during construction
-     * of this model object. (keys are model field names, values are their values).
-     * This list is important to remember so that when we are merging data from the db, we know
-     * which values to override and which to not override.
-     *
-     * @var array
-     */
-    protected $_props_n_values_provided_in_constructor;
-
-    /**
-     * Timezone
-     * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
-     * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
-     * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
-     * access to it.
-     *
-     * @var string
-     */
-    protected $_timezone;
-
-    /**
-     * date format
-     * pattern or format for displaying dates
-     *
-     * @var string $_dt_frmt
-     */
-    protected $_dt_frmt;
-
-    /**
-     * time format
-     * pattern or format for displaying time
-     *
-     * @var string $_tm_frmt
-     */
-    protected $_tm_frmt;
-
-    /**
-     * This property is for holding a cached array of object properties indexed by property name as the key.
-     * The purpose of this is for setting a cache on properties that may have calculated values after a
-     * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
-     * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
-     *
-     * @var array
-     */
-    protected $_cached_properties = array();
-
-    /**
-     * An array containing keys of the related model, and values are either an array of related mode objects or a
-     * single
-     * related model object. see the model's _model_relations. The keys should match those specified. And if the
-     * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
-     * all others have an array)
-     *
-     * @var array
-     */
-    protected $_model_relations = array();
-
-    /**
-     * Array where keys are field names (see the model's _fields property) and values are their values. To see what
-     * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
-     *
-     * @var array
-     */
-    protected $_fields = array();
-
-    /**
-     * @var boolean indicating whether or not this model object is intended to ever be saved
-     * For example, we might create model objects intended to only be used for the duration
-     * of this request and to be thrown away, and if they were accidentally saved
-     * it would be a bug.
-     */
-    protected $_allow_persist = true;
-
-    /**
-     * @var boolean indicating whether or not this model object's properties have changed since construction
-     */
-    protected $_has_changes = false;
-
-    /**
-     * @var EEM_Base
-     */
-    protected $_model;
-
-    /**
-     * This is a cache of results from custom selections done on a query that constructs this entity. The only purpose
-     * for these values is for retrieval of the results, they are not further queryable and they are not persisted to
-     * the db.  They also do not automatically update if there are any changes to the data that produced their results.
-     * The format is a simple array of field_alias => field_value.  So for instance if a custom select was something
-     * like,  "Select COUNT(Registration.REG_ID) as Registration_Count ...", then the resulting value will be in this
-     * array as:
-     * array(
-     *  'Registration_Count' => 24
-     * );
-     * Note: if the custom select configuration for the query included a data type, the value will be in the data type
-     * provided for the query (@see EventEspresso\core\domain\values\model\CustomSelects::__construct phpdocs for more
-     * info)
-     *
-     * @var array
-     */
-    protected $custom_selection_results = array();
-
-
-    /**
-     * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
-     * play nice
-     *
-     * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
-     *                                                         layer of the model's _fields array, (eg, EVT_ID,
-     *                                                         TXN_amount, QST_name, etc) and values are their values
-     * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
-     *                                                         corresponding db model or not.
-     * @param string  $timezone                                indicate what timezone you want any datetime fields to
-     *                                                         be in when instantiating a EE_Base_Class object.
-     * @param array   $date_formats                            An array of date formats to set on construct where first
-     *                                                         value is the date_format and second value is the time
-     *                                                         format.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
-    {
-        $className = get_class($this);
-        do_action("AHEE__{$className}__construct", $this, $fieldValues);
-        $model        = $this->get_model();
-        $model_fields = $model->field_settings(false);
-        // ensure $fieldValues is an array
-        $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
-        // verify client code has not passed any invalid field names
-        foreach ($fieldValues as $field_name => $field_value) {
-            if (! isset($model_fields[ $field_name ])) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Invalid field (%s) passed to constructor of %s. Allowed fields are :%s',
-                            'event_espresso'
-                        ),
-                        $field_name,
-                        get_class($this),
-                        implode(', ', array_keys($model_fields))
-                    )
-                );
-            }
-        }
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if (! empty($date_formats) && is_array($date_formats)) {
-            list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
-        } else {
-            //set default formats for date and time
-            $this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
-            $this->_tm_frmt = (string) get_option('time_format', 'g:i a');
-        }
-        //if db model is instantiating
-        if ($bydb) {
-            //client code has indicated these field values are from the database
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set_from_db(
-                    $fieldName,
-                    isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null
-                );
-            }
-        } else {
-            //we're constructing a brand
-            //new instance of the model object. Generally, this means we'll need to do more field validation
-            foreach ($model_fields as $fieldName => $field) {
-                $this->set(
-                    $fieldName,
-                    isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null, true
-                );
-            }
-        }
-        //remember what values were passed to this constructor
-        $this->_props_n_values_provided_in_constructor = $fieldValues;
-        //remember in entity mapper
-        if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
-            $model->add_to_entity_map($this);
-        }
-        //setup all the relations
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[ $relation_name ] = null;
-            } else {
-                $this->_model_relations[ $relation_name ] = array();
-            }
-        }
-        /**
-         * Action done at the end of each model object construction
-         *
-         * @param EE_Base_Class $this the model object just created
-         */
-        do_action('AHEE__EE_Base_Class__construct__finished', $this);
-    }
-
-
-    /**
-     * Gets whether or not this model object is allowed to persist/be saved to the database.
-     *
-     * @return boolean
-     */
-    public function allow_persist()
-    {
-        return $this->_allow_persist;
-    }
-
-
-    /**
-     * Sets whether or not this model object should be allowed to be saved to the DB.
-     * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
-     * you got new information that somehow made you change your mind.
-     *
-     * @param boolean $allow_persist
-     * @return boolean
-     */
-    public function set_allow_persist($allow_persist)
-    {
-        return $this->_allow_persist = $allow_persist;
-    }
-
-
-    /**
-     * Gets the field's original value when this object was constructed during this request.
-     * This can be helpful when determining if a model object has changed or not
-     *
-     * @param string $field_name
-     * @return mixed|null
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_original($field_name)
-    {
-        if (isset($this->_props_n_values_provided_in_constructor[ $field_name ])
-            && $field_settings = $this->get_model()->field_settings_for($field_name)
-        ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
-        }
-        return null;
-    }
-
-
-    /**
-     * @param EE_Base_Class $obj
-     * @return string
-     */
-    public function get_class($obj)
-    {
-        return get_class($obj);
-    }
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param    string $field_name
-     * @param    mixed  $field_value
-     * @param bool      $use_default
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function set($field_name, $field_value, $use_default = false)
-    {
-        // if not using default and nothing has changed, and object has already been setup (has ID),
-        // then don't do anything
-        if (
-            ! $use_default
-            && $this->_fields[ $field_name ] === $field_value
-            && $this->ID()
-        ) {
-            return;
-        }
-        $model              = $this->get_model();
-        $this->_has_changes = true;
-        $field_obj          = $model->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //			if ( method_exists( $field_obj, 'set_timezone' )) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                $field_obj->set_date_format($this->_dt_frmt);
-                $field_obj->set_time_format($this->_tm_frmt);
-            }
-            $holder_of_value = $field_obj->prepare_for_set($field_value);
-            //should the value be null?
-            if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[ $field_name ] = $field_obj->get_default_value();
-                /**
-                 * To save having to refactor all the models, if a default value is used for a
-                 * EE_Datetime_Field, and that value is not null nor is it a DateTime
-                 * object.  Then let's do a set again to ensure that it becomes a DateTime
-                 * object.
-                 *
-                 * @since 4.6.10+
-                 */
-                if (
-                    $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[ $field_name ] !== null
-                    && ! $this->_fields[ $field_name ] instanceof DateTime
-                ) {
-                    empty($this->_fields[ $field_name ])
-                        ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[ $field_name ]);
-                }
-            } else {
-                $this->_fields[ $field_name ] = $holder_of_value;
-            }
-            //if we're not in the constructor...
-            //now check if what we set was a primary key
-            if (
-                //note: props_n_values_provided_in_constructor is only set at the END of the constructor
-                $this->_props_n_values_provided_in_constructor
-                && $field_value
-                && $field_name === $model->primary_key_name()
-            ) {
-                //if so, we want all this object's fields to be filled either with
-                //what we've explicitly set on this model
-                //or what we have in the db
-                // echo "setting primary key!";
-                $fields_on_model = self::_get_model(get_class($this))->field_settings();
-                $obj_in_db       = self::_get_model(get_class($this))->get_one_by_ID($field_value);
-                foreach ($fields_on_model as $field_obj) {
-                    if (! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
-                        && $field_obj->get_name() !== $field_name
-                    ) {
-                        $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
-                    }
-                }
-                //oh this model object has an ID? well make sure its in the entity mapper
-                $model->add_to_entity_map($this);
-            }
-            //let's unset any cache for this field_name from the $_cached_properties property.
-            $this->_clear_cached_property($field_name);
-        } else {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'A valid EE_Model_Field_Base could not be found for the given field name: %s',
-                        'event_espresso'
-                    ),
-                    $field_name
-                )
-            );
-        }
-    }
-
-
-    /**
-     * Set custom select values for model.
-     *
-     * @param array $custom_select_values
-     */
-    public function setCustomSelectsValues(array $custom_select_values)
-    {
-        $this->custom_selection_results = $custom_select_values;
-    }
-
-
-    /**
-     * Returns the custom select value for the provided alias if its set.
-     * If not set, returns null.
-     *
-     * @param string $alias
-     * @return string|int|float|null
-     */
-    public function getCustomSelect($alias)
-    {
-        return isset($this->custom_selection_results[ $alias ])
-            ? $this->custom_selection_results[ $alias ]
-            : null;
-    }
-
-
-    /**
-     * This sets the field value on the db column if it exists for the given $column_name or
-     * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
-     *
-     * @see EE_message::get_column_value for related documentation on the necessity of this method.
-     * @param string $field_name  Must be the exact column name.
-     * @param mixed  $field_value The value to set.
-     * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_field_or_extra_meta($field_name, $field_value)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $this->set($field_name, $field_value);
-            return true;
-        }
-        //ensure this object is saved first so that extra meta can be properly related.
-        $this->save();
-        return $this->update_extra_meta($field_name, $field_value);
-    }
-
-
-    /**
-     * This retrieves the value of the db column set on this class or if that's not present
-     * it will attempt to retrieve from extra_meta if found.
-     * Example Usage:
-     * Via EE_Message child class:
-     * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
-     * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
-     * also have additional main fields specific to the messenger.  The system accommodates those extra
-     * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
-     * value for those extra fields dynamically via the EE_message object.
-     *
-     * @param  string $field_name expecting the fully qualified field name.
-     * @return mixed|null  value for the field if found.  null if not found.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_field_or_extra_meta($field_name)
-    {
-        if ($this->get_model()->has_field($field_name)) {
-            $column_value = $this->get($field_name);
-        } else {
-            //This isn't a column in the main table, let's see if it is in the extra meta.
-            $column_value = $this->get_extra_meta($field_name, true, null);
-        }
-        return $column_value;
-    }
-
-
-    /**
-     * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
-     * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
-     * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
-     * available to all child classes that may be using the EE_Datetime_Field for a field data type.
-     *
-     * @access public
-     * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_timezone($timezone = '')
-    {
-        $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        //make sure we clear all cached properties because they won't be relevant now
-        $this->_clear_cached_properties();
-        //make sure we update field settings and the date for all EE_Datetime_Fields
-        $model_fields = $this->get_model()->field_settings(false);
-        foreach ($model_fields as $field_name => $field_obj) {
-            if ($field_obj instanceof EE_Datetime_Field) {
-                $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
-                    $this->_fields[ $field_name ]->setTimezone(new DateTimeZone($this->_timezone));
-                }
-            }
-        }
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone()
-    {
-        return $this->_timezone;
-    }
-
-
-    /**
-     * This sets the internal date format to what is sent in to be used as the new default for the class
-     * internally instead of wp set date format options
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_date_format($format)
-    {
-        $this->_dt_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-    /**
-     * This sets the internal time format string to what is sent in to be used as the new default for the
-     * class internally instead of wp set time format options.
-     *
-     * @since 4.6
-     * @param string $format should be a format recognizable by PHP date() functions.
-     */
-    public function set_time_format($format)
-    {
-        $this->_tm_frmt = $format;
-        //clear cached_properties because they won't be relevant now.
-        $this->_clear_cached_properties();
-    }
-
-
-    /**
-     * This returns the current internal set format for the date and time formats.
-     *
-     * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
-     *                             where the first value is the date format and the second value is the time format.
-     * @return mixed string|array
-     */
-    public function get_format($full = true)
-    {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
-    }
-
-
-    /**
-     * cache
-     * stores the passed model object on the current model object.
-     * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
-     *
-     * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
-     *                                       'Registration' associated with this model object
-     * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
-     *                                       that could be a payment or a registration)
-     * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
-     *                                       items which will be stored in an array on this object
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
-     *                                       related thing, no array)
-     */
-    public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
-    {
-        // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if (! $object_to_cache instanceof EE_Base_Class) {
-            return false;
-        }
-        // also get "how" the object is related, or throw an error
-        if (! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        // how many things are related ?
-        if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            // if it's a "belongs to" relationship, then there's only one related model object
-            // eg, if this is a registration, there's only 1 attendee for it
-            // so for these model objects just set it to be cached
-            $this->_model_relations[ $relationName ] = $object_to_cache;
-            $return                                  = true;
-        } else {
-            // otherwise, this is the "many" side of a one to many relationship,
-            // so we'll add the object to the array of related objects for that type.
-            // eg: if this is an event, there are many registrations for that event,
-            // so we cache the registrations in an array
-            if (! is_array($this->_model_relations[ $relationName ])) {
-                // if for some reason, the cached item is a model object,
-                // then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[ $relationName ] = $this->_model_relations[ $relationName ]
-                                                           instanceof
-                                                           EE_Base_Class
-                    ? array($this->_model_relations[ $relationName ]) : array();
-            }
-            // first check for a cache_id which is normally empty
-            if (! empty($cache_id)) {
-                // if the cache_id exists, then it means we are purposely trying to cache this
-                // with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[ $relationName ][ $cache_id ] = $object_to_cache;
-                $return                                               = $cache_id;
-            } elseif ($object_to_cache->ID()) {
-                // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[ $relationName ][ $object_to_cache->ID() ] = $object_to_cache;
-                $return                                                            = $object_to_cache->ID();
-            } else {
-                // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[ $relationName ][] = $object_to_cache;
-                // move the internal pointer to the end of the array
-                end($this->_model_relations[ $relationName ]);
-                // and grab the key so that we can return it
-                $return = key($this->_model_relations[ $relationName ]);
-            }
-        }
-        return $return;
-    }
-
-
-    /**
-     * For adding an item to the cached_properties property.
-     *
-     * @access protected
-     * @param string      $fieldname the property item the corresponding value is for.
-     * @param mixed       $value     The value we are caching.
-     * @param string|null $cache_type
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_cached_property($fieldname, $value, $cache_type = null)
-    {
-        //first make sure this property exists
-        $this->get_model()->field_settings_for($fieldname);
-        $cache_type                                            = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
-    }
-
-
-    /**
-     * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
-     * This also SETS the cache if we return the actual property!
-     *
-     * @param string $fieldname        the name of the property we're trying to retrieve
-     * @param bool   $pretty
-     * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
-     *                                 (in cases where the same property may be used for different outputs
-     *                                 - i.e. datetime, money etc.)
-     *                                 It can also accept certain pre-defined "schema" strings
-     *                                 to define how to output the property.
-     *                                 see the field's prepare_for_pretty_echoing for what strings can be used
-     * @return mixed                   whatever the value for the property is we're retrieving
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        //verify the field exists
-        $model = $this->get_model();
-        $model->field_settings_for($fieldname);
-        $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
-            return $this->_cached_properties[ $fieldname ][ $cache_type ];
-        }
-        $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
-        $this->_set_cached_property($fieldname, $value, $cache_type);
-        return $value;
-    }
-
-
-    /**
-     * If the cache didn't fetch the needed item, this fetches it.
-     *
-     * @param string $fieldname
-     * @param bool   $pretty
-     * @param string $extra_cache_ref
-     * @return mixed
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
-    {
-        $field_obj = $this->get_model()->field_settings_for($fieldname);
-        // If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
-        if ($field_obj instanceof EE_Datetime_Field) {
-            $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
-        }
-        if (! isset($this->_fields[ $fieldname ])) {
-            $this->_fields[ $fieldname ] = null;
-        }
-        $value = $pretty
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
-            : $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
-        return $value;
-    }
-
-
-    /**
-     * set timezone, formats, and output for EE_Datetime_Field objects
-     *
-     * @param \EE_Datetime_Field $datetime_field
-     * @param bool               $pretty
-     * @param null               $date_or_time
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _prepare_datetime_field(
-        EE_Datetime_Field $datetime_field,
-        $pretty = false,
-        $date_or_time = null
-    ) {
-        $datetime_field->set_timezone($this->_timezone);
-        $datetime_field->set_date_format($this->_dt_frmt, $pretty);
-        $datetime_field->set_time_format($this->_tm_frmt, $pretty);
-        //set the output returned
-        switch ($date_or_time) {
-            case 'D' :
-                $datetime_field->set_date_time_output('date');
-                break;
-            case 'T' :
-                $datetime_field->set_date_time_output('time');
-                break;
-            default :
-                $datetime_field->set_date_time_output();
-        }
-    }
-
-
-    /**
-     * This just takes care of clearing out the cached_properties
-     *
-     * @return void
-     */
-    protected function _clear_cached_properties()
-    {
-        $this->_cached_properties = array();
-    }
-
-
-    /**
-     * This just clears out ONE property if it exists in the cache
-     *
-     * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
-     * @return void
-     */
-    protected function _clear_cached_property($property_name)
-    {
-        if (isset($this->_cached_properties[ $property_name ])) {
-            unset($this->_cached_properties[ $property_name ]);
-        }
-    }
-
-
-    /**
-     * Ensures that this related thing is a model object.
-     *
-     * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
-     * @param string $model_name   name of the related thing, eg 'Attendee',
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
-    {
-        $other_model_instance = self::_get_model_instance_with_name(
-            self::_get_model_classname($model_name),
-            $this->_timezone
-        );
-        return $other_model_instance->ensure_is_obj($object_or_id);
-    }
-
-
-    /**
-     * Forgets the cached model of the given relation Name. So the next time we request it,
-     * we will fetch it again from the database. (Handy if you know it's changed somehow).
-     * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
-     * then only remove that one object from our cached array. Otherwise, clear the entire list
-     *
-     * @param string $relationName                         one of the keys in the _model_relations array on the model.
-     *                                                     Eg 'Registration'
-     * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
-     *                                                     if you intend to use $clear_all = TRUE, or the relation only
-     *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
-     * @param bool   $clear_all                            This flags clearing the entire cache relation property if
-     *                                                     this is HasMany or HABTM.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
-     *                                                     relation from all
-     */
-    public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
-    {
-        $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-        $index_in_cache        = '';
-        if (! $relationship_to_model) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
-                    $relationName,
-                    get_class($this)
-                )
-            );
-        }
-        if ($clear_all) {
-            $obj_removed                             = true;
-            $this->_model_relations[ $relationName ] = null;
-        } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed                             = $this->_model_relations[ $relationName ];
-            $this->_model_relations[ $relationName ] = null;
-        } else {
-            if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
-                && $object_to_remove_or_index_into_array->ID()
-            ) {
-                $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[ $relationName ])
-                    && ! isset($this->_model_relations[ $relationName ][ $index_in_cache ])
-                ) {
-                    $index_found_at = null;
-                    //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[ $relationName ] as $index => $obj) {
-                        /** @noinspection TypeUnsafeComparisonInspection */
-                        if (
-                            $obj instanceof EE_Base_Class
-                            && (
-                                $obj == $object_to_remove_or_index_into_array
-                                || $obj->ID() === $object_to_remove_or_index_into_array->ID()
-                            )
-                        ) {
-                            $index_found_at = $index;
-                            break;
-                        }
-                    }
-                    if ($index_found_at) {
-                        $index_in_cache = $index_found_at;
-                    } else {
-                        //it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
-                        //if it wasn't in it to begin with. So we're done
-                        return $object_to_remove_or_index_into_array;
-                    }
-                }
-            } elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
-                //so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
-                foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
-                    /** @noinspection TypeUnsafeComparisonInspection */
-                    if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
-                        $index_in_cache = $index;
-                    }
-                }
-            } else {
-                $index_in_cache = $object_to_remove_or_index_into_array;
-            }
-            //supposedly we've found it. But it could just be that the client code
-            //provided a bad index/object
-            if (isset($this->_model_relations[ $relationName ][ $index_in_cache ])) {
-                $obj_removed = $this->_model_relations[ $relationName ][ $index_in_cache ];
-                unset($this->_model_relations[ $relationName ][ $index_in_cache ]);
-            } else {
-                //that thing was never cached anyways.
-                $obj_removed = null;
-            }
-        }
-        return $obj_removed;
-    }
-
-
-    /**
-     * update_cache_after_object_save
-     * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
-     * obtained after being saved to the db
-     *
-     * @param string        $relationName       - the type of object that is cached
-     * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
-     * @param string        $current_cache_id   - the ID that was used when originally caching the object
-     * @return boolean TRUE on success, FALSE on fail
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function update_cache_after_object_save(
-        $relationName,
-        EE_Base_Class $newly_saved_object,
-        $current_cache_id = ''
-    ) {
-        // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
-        if ($newly_saved_object instanceof $obj_class) {
-            /* @type EE_Base_Class $newly_saved_object */
-            // now get the type of relation
-            $relationship_to_model = $this->get_model()->related_settings_for($relationName);
-            // if this is a 1:1 relationship
-            if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-                // then just replace the cached object with the newly saved object
-                $this->_model_relations[ $relationName ] = $newly_saved_object;
-                return true;
-                // or if it's some kind of sordid feral polyamorous relationship...
-            }
-            if (is_array($this->_model_relations[ $relationName ])
-                      && isset($this->_model_relations[ $relationName ][ $current_cache_id ])
-            ) {
-                // then remove the current cached item
-                unset($this->_model_relations[ $relationName ][ $current_cache_id ]);
-                // and cache the newly saved object using it's new ID
-                $this->_model_relations[ $relationName ][ $newly_saved_object->ID() ] = $newly_saved_object;
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @return EE_Base_Class
-     */
-    public function get_one_from_cache($relationName)
-    {
-        $cached_array_or_object = isset($this->_model_relations[ $relationName ])
-            ? $this->_model_relations[ $relationName ]
-            : null;
-        if (is_array($cached_array_or_object)) {
-            return array_shift($cached_array_or_object);
-        }
-        return $cached_array_or_object;
-    }
-
-
-    /**
-     * Fetches a single EE_Base_Class on that relation. (If the relation is of type
-     * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
-     *
-     * @param string $relationName
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return EE_Base_Class[] NOT necessarily indexed by primary keys
-     */
-    public function get_all_from_cache($relationName)
-    {
-        $objects = isset($this->_model_relations[ $relationName ]) ? $this->_model_relations[ $relationName ] : array();
-        // if the result is not an array, but exists, make it an array
-        $objects = is_array($objects) ? $objects : array($objects);
-        //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
-        //basically, if this model object was stored in the session, and these cached model objects
-        //already have IDs, let's make sure they're in their model's entity mapper
-        //otherwise we will have duplicates next time we call
-        // EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
-        $model = EE_Registry::instance()->load_model($relationName);
-        foreach ($objects as $model_object) {
-            if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
-                //ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
-                if ($model_object->ID()) {
-                    $model->add_to_entity_map($model_object);
-                }
-            } else {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
-                            'event_espresso'
-                        ),
-                        $relationName,
-                        gettype($model_object)
-                    )
-                );
-            }
-        }
-        return $objects;
-    }
-
-
-    /**
-     * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param int   $limit              How many objects to return.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class[]
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function previous_x(
-        $field_to_order_by = null,
-        $limit = 1,
-        $query_params = array(),
-        $columns_to_select = null
-    ) {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the next EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
-     *                                  you can indicate just the columns you want returned
-     * @return array|EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->next($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Returns the previous EE_Base_Class object in sequence from this object as found in the database
-     * matching the given query conditions.
-     *
-     * @param null  $field_to_order_by  What field is being used as the reference point.
-     * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
-     *                                  you can indicate just the column you want returned
-     * @return array|EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
-    {
-        $model         = $this->get_model();
-        $field         = empty($field_to_order_by) && $model->has_primary_key_field()
-            ? $model->get_primary_key_field()->get_name()
-            : $field_to_order_by;
-        $current_value = ! empty($field) ? $this->get($field) : null;
-        if (empty($field) || empty($current_value)) {
-            return array();
-        }
-        return $model->previous($current_value, $field, $query_params, $columns_to_select);
-    }
-
-
-    /**
-     * Overrides parent because parent expects old models.
-     * This also doesn't do any validation, and won't work for serialized arrays
-     *
-     * @param string $field_name
-     * @param mixed  $field_value_from_db
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function set_from_db($field_name, $field_value_from_db)
-    {
-        $field_obj = $this->get_model()->field_settings_for($field_name);
-        if ($field_obj instanceof EE_Model_Field_Base) {
-            //you would think the DB has no NULLs for non-null label fields right? wrong!
-            //eg, a CPT model object could have an entry in the posts table, but no
-            //entry in the meta table. Meaning that all its columns in the meta table
-            //are null! yikes! so when we find one like that, use defaults for its meta columns
-            if ($field_value_from_db === null) {
-                if ($field_obj->is_nullable()) {
-                    //if the field allows nulls, then let it be null
-                    $field_value = null;
-                } else {
-                    $field_value = $field_obj->get_default_value();
-                }
-            } else {
-                $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
-            }
-            $this->_fields[ $field_name ] = $field_value;
-            $this->_clear_cached_property($field_name);
-        }
-    }
-
-
-    /**
-     * verifies that the specified field is of the correct type
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, false, $extra_cache_ref);
-    }
-
-
-    /**
-     * This method simply returns the RAW unprocessed value for the given property in this class
-     *
-     * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
-     */
-    public function get_raw($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
-            ? $this->_fields[ $field_name ]->format('U')
-            : $this->_fields[ $field_name ];
-    }
-
-
-    /**
-     * This is used to return the internal DateTime object used for a field that is a
-     * EE_Datetime_Field.
-     *
-     * @param string $field_name               The field name retrieving the DateTime object.
-     * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     *                                         an error is set and false returned.  If the field IS an
-     *                                         EE_Datetime_Field and but the field value is null, then
-     *                                         just null is returned (because that indicates that likely
-     *                                         this field is nullable).
-     */
-    public function get_DateTime_object($field_name)
-    {
-        $field_settings = $this->get_model()->field_settings_for($field_name);
-        if (! $field_settings instanceof EE_Datetime_Field) {
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
-                        'event_espresso'
-                    ),
-                    $field_name
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return $this->_fields[ $field_name ];
-    }
-
-
-    /**
-     * To be used in template to immediately echo out the value, and format it for output.
-     * Eg, should call stripslashes and whatnot before echoing
-     *
-     * @param string $field_name      the name of the field as it appears in the DB
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e($field_name, $extra_cache_ref = null)
-    {
-        echo $this->get_pretty($field_name, $extra_cache_ref);
-    }
-
-
-    /**
-     * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
-     * can be easily used as the value of form input.
-     *
-     * @param string $field_name
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function f($field_name)
-    {
-        $this->e($field_name, 'form_input');
-    }
-
-
-    /**
-     * Same as `f()` but just returns the value instead of echoing it
-     *
-     * @param string $field_name
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_f($field_name)
-    {
-        return (string) $this->get_pretty($field_name, 'form_input');
-    }
-
-
-    /**
-     * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
-     * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
-     * to see what options are available.
-     *
-     * @param string $field_name
-     * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
-     *                                (in cases where the same property may be used for different outputs
-     *                                - i.e. datetime, money etc.)
-     * @return mixed
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_pretty($field_name, $extra_cache_ref = null)
-    {
-        return $this->_get_cached_property($field_name, true, $extra_cache_ref);
-    }
-
-
-    /**
-     * This simply returns the datetime for the given field name
-     * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
-     * (and the equivalent e_date, e_time, e_datetime).
-     *
-     * @access   protected
-     * @param string   $field_name   Field on the instantiated EE_Base_Class child object
-     * @param string   $dt_frmt      valid datetime format used for date
-     *                               (if '' then we just use the default on the field,
-     *                               if NULL we use the last-used format)
-     * @param string   $tm_frmt      Same as above except this is for time format
-     * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
-     * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
-     * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
-     *                               if field is not a valid dtt field, or void if echoing
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
-    {
-        // clear cached property
-        $this->_clear_cached_property($field_name);
-        //reset format properties because they are used in get()
-        $this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
-        $this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
-        if ($echo) {
-            $this->e($field_name, $date_or_time);
-            return '';
-        }
-        return $this->get($field_name, $date_or_time);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
-     * @return string            datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_date($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, $format, null, 'D');
-    }
-
-
-    /**
-     * @param        $field_name
-     * @param string $format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_date($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, $format, null, 'D', true);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
-     * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_time($field_name, $format = '')
-    {
-        return $this->_get_datetime($field_name, null, $format, 'T');
-    }
-
-
-    /**
-     * @param        $field_name
-     * @param string $format
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_time($field_name, $format = '')
-    {
-        $this->_get_datetime($field_name, null, $format, 'T', true);
-    }
-
-
-    /**
-     * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
-     * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
-     * other echoes the pretty value for dtt)
-     *
-     * @param  string $field_name name of model object datetime field holding the value
-     * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
-     * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
-     * @return string             datetime value formatted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
-    }
-
-
-    /**
-     * @param string $field_name
-     * @param string $dt_frmt
-     * @param string $tm_frmt
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
-    {
-        $this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
-    }
-
-
-    /**
-     * Get the i8ln value for a date using the WordPress @see date_i18n function.
-     *
-     * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
-     * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
-     *                           on the object will be used.
-     * @return string Date and time string in set locale or false if no field exists for the given
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     *                           field name.
-     */
-    public function get_i18n_datetime($field_name, $format = '')
-    {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
-        return date_i18n(
-            $format,
-            EEH_DTT_Helper::get_timestamp_with_offset(
-                $this->get_raw($field_name),
-                $this->_timezone
-            )
-        );
-    }
-
-
-    /**
-     * This method validates whether the given field name is a valid field on the model object as well as it is of a
-     * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
-     * thrown.
-     *
-     * @param  string $field_name The field name being checked
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return EE_Datetime_Field
-     */
-    protected function _get_dtt_field_settings($field_name)
-    {
-        $field = $this->get_model()->field_settings_for($field_name);
-        //check if field is dtt
-        if ($field instanceof EE_Datetime_Field) {
-            return $field;
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__(
-                    'The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
-                    'event_espresso'
-                ),
-                $field_name,
-                self::_get_model_classname(get_class($this))
-            )
-        );
-    }
-
-
-
-
-    /**
-     * NOTE ABOUT BELOW:
-     * These convenience date and time setters are for setting date and time independently.  In other words you might
-     * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
-     * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
-     * method and make sure you send the entire datetime value for setting.
-     */
-    /**
-     * sets the time on a datetime property
-     *
-     * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
-     * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_time_for($time, $fieldname)
-    {
-        $this->_set_date_time('T', $time, $fieldname);
-    }
-
-
-    /**
-     * sets the date on a datetime property
-     *
-     * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
-     * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_date_for($date, $fieldname)
-    {
-        $this->_set_date_time('D', $date, $fieldname);
-    }
-
-
-    /**
-     * This takes care of setting a date or time independently on a given model object property. This method also
-     * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
-     *
-     * @access protected
-     * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
-     * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
-     * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
-     *                                        EE_Datetime_Field property)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
-    {
-        $field = $this->_get_dtt_field_settings($fieldname);
-        $field->set_timezone($this->_timezone);
-        $field->set_date_format($this->_dt_frmt);
-        $field->set_time_format($this->_tm_frmt);
-        switch ($what) {
-            case 'T' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_time(
-                    $datetime_value,
-                    $this->_fields[ $fieldname ]
-                );
-                break;
-            case 'D' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_date(
-                    $datetime_value,
-                    $this->_fields[ $fieldname ]
-                );
-                break;
-            case 'B' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set($datetime_value);
-                break;
-        }
-        $this->_clear_cached_property($fieldname);
-    }
-
-
-    /**
-     * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
-     * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
-     * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
-     * that could lead to some unexpected results!
-     *
-     * @access public
-     * @param string $field_name               This is the name of the field on the object that contains the date/time
-     *                                         value being returned.
-     * @param string $callback                 must match a valid method in this class (defaults to get_datetime)
-     * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
-     * @param string $prepend                  You can include something to prepend on the timestamp
-     * @param string $append                   You can include something to append on the timestamp
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return string timestamp
-     */
-    public function display_in_my_timezone(
-        $field_name,
-        $callback = 'get_datetime',
-        $args = null,
-        $prepend = '',
-        $append = ''
-    ) {
-        $timezone = EEH_DTT_Helper::get_timezone();
-        if ($timezone === $this->_timezone) {
-            return '';
-        }
-        $original_timezone = $this->_timezone;
-        $this->set_timezone($timezone);
-        $fn   = (array) $field_name;
-        $args = array_merge($fn, (array) $args);
-        if (! method_exists($this, $callback)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
-                        'event_espresso'
-                    ),
-                    $callback
-                )
-            );
-        }
-        $args   = (array) $args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
-        $this->set_timezone($original_timezone);
-        return $return;
-    }
-
-
-    /**
-     * Deletes this model object.
-     * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
-     * override
-     * `EE_Base_Class::_delete` NOT this class.
-     *
-     * @return boolean | int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete()
-    {
-        /**
-         * Called just before the `EE_Base_Class::_delete` method call.
-         * Note:
-         * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.
-         * For example, `EE_Soft_Delete_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete__before', $this);
-        $result = $this->_delete();
-        /**
-         * Called just after the `EE_Base_Class::_delete` method call.
-         * Note:
-         * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
-         * should be aware that `_delete` may not always result in a permanent delete.
-         * For example `EE_Soft_Base_Class::_delete`
-         * soft deletes (trash) the object and does not permanently delete it.
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
-        return $result;
-    }
-
-
-    /**
-     * Calls the specific delete method for the instantiated class.
-     * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
-     * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
-     * `EE_Base_Class::delete`
-     *
-     * @return bool|int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _delete()
-    {
-        return $this->delete_permanently();
-    }
-
-
-    /**
-     * Deletes this model object permanently from db
-     * (but keep in mind related models may block the delete and return an error)
-     *
-     * @return bool | int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_permanently()
-    {
-        /**
-         * Called just before HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object about to be 'deleted'
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
-        $model  = $this->get_model();
-        $result = $model->delete_permanently_by_ID($this->ID());
-        $this->refresh_cache_of_related_objects();
-        /**
-         * Called just after HARD deleting a model object
-         *
-         * @param EE_Base_Class $model_object that was just 'deleted'
-         * @param boolean       $result
-         */
-        do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
-        return $result;
-    }
-
-
-    /**
-     * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
-     * related model objects
-     *
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function refresh_cache_of_related_objects()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if (! empty($this->_model_relations[ $relation_name ])) {
-                $related_objects = $this->_model_relations[ $relation_name ];
-                if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                    //this relation only stores a single model object, not an array
-                    //but let's make it consistent
-                    $related_objects = array($related_objects);
-                }
-                foreach ($related_objects as $related_object) {
-                    //only refresh their cache if they're in memory
-                    if ($related_object instanceof EE_Base_Class) {
-                        $related_object->clear_cache(
-                            $model->get_this_model_name(),
-                            $this
-                        );
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     *        Saves this object to the database. An array may be supplied to set some values on this
-     * object just before saving.
-     *
-     * @access public
-     * @param array $set_cols_n_values keys are field names, values are their new values,
-     *                                 if provided during the save() method (often client code will change the fields'
-     *                                 values before calling save)
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
-     *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
-     * @throws ReflectionException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function save($set_cols_n_values = array())
-    {
-        $model = $this->get_model();
-        /**
-         * Filters the fields we're about to save on the model object
-         *
-         * @param array         $set_cols_n_values
-         * @param EE_Base_Class $model_object
-         */
-        $set_cols_n_values = (array) apply_filters(
-            'FHEE__EE_Base_Class__save__set_cols_n_values',
-            $set_cols_n_values,
-            $this
-        );
-        //set attributes as provided in $set_cols_n_values
-        foreach ($set_cols_n_values as $column => $value) {
-            $this->set($column, $value);
-        }
-        // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
-            return 0;
-        }
-        /**
-         * Saving a model object.
-         * Before we perform a save, this action is fired.
-         *
-         * @param EE_Base_Class $model_object the model object about to be saved.
-         */
-        do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if (! $this->allow_persist()) {
-            return 0;
-        }
-        // now get current attribute values
-        $save_cols_n_values = $this->_fields;
-        // if the object already has an ID, update it. Otherwise, insert it
-        // also: change the assumption about values passed to the model NOT being prepare dby the model object.
-        // They have been
-        $old_assumption_concerning_value_preparation = $model
-            ->get_assumption_concerning_values_already_prepared_by_model_object();
-        $model->assume_values_already_prepared_by_model_object(true);
-        //does this model have an autoincrement PK?
-        if ($model->has_primary_key_field()) {
-            if ($model->get_primary_key_field()->is_auto_increment()) {
-                //ok check if it's set, if so: update; if not, insert
-                if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    unset($save_cols_n_values[ $model->primary_key_name() ]);
-                    $results = $model->insert($save_cols_n_values);
-                    if ($results) {
-                        //if successful, set the primary key
-                        //but don't use the normal SET method, because it will check if
-                        //an item with the same ID exists in the mapper & db, then
-                        //will find it in the db (because we just added it) and THAT object
-                        //will get added to the mapper before we can add this one!
-                        //but if we just avoid using the SET method, all that headache can be avoided
-                        $pk_field_name                   = $model->primary_key_name();
-                        $this->_fields[ $pk_field_name ] = $results;
-                        $this->_clear_cached_property($pk_field_name);
-                        $model->add_to_entity_map($this);
-                        $this->_update_cached_related_model_objs_fks();
-                    }
-                }
-            } else {//PK is NOT auto-increment
-                //so check if one like it already exists in the db
-                if ($model->exists_by_ID($this->ID())) {
-                    if (WP_DEBUG && ! $this->in_entity_map()) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
-                                    'event_espresso'
-                                ),
-                                get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
-                                '<br />'
-                            )
-                        );
-                    }
-                    $results = $model->update_by_ID($save_cols_n_values, $this->ID());
-                } else {
-                    $results = $model->insert($save_cols_n_values);
-                    $this->_update_cached_related_model_objs_fks();
-                }
-            }
-        } else {//there is NO primary key
-            $already_in_db = false;
-            foreach ($model->unique_indexes() as $index) {
-                $uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
-                if ($model->exists(array($uniqueness_where_params))) {
-                    $already_in_db = true;
-                }
-            }
-            if ($already_in_db) {
-                $combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
-                    $model->get_combined_primary_key_fields());
-                $results                     = $model->update(
-                    $save_cols_n_values,
-                    $combined_pk_fields_n_values
-                );
-            } else {
-                $results = $model->insert($save_cols_n_values);
-            }
-        }
-        //restore the old assumption about values being prepared by the model object
-        $model->assume_values_already_prepared_by_model_object(
-                $old_assumption_concerning_value_preparation
-            );
-        /**
-         * After saving the model object this action is called
-         *
-         * @param EE_Base_Class $model_object which was just saved
-         * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
-         *                                    the new ID (or 0 if an error occurred and it wasn't updated)
-         */
-        do_action('AHEE__EE_Base_Class__save__end', $this, $results);
-        $this->_has_changes = false;
-        return $results;
-    }
-
-
-    /**
-     * Updates the foreign key on related models objects pointing to this to have this model object's ID
-     * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
-     * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
-     * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
-     * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
-     * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
-     * or not they exist in the DB (if they do, their DB records will be automatically updated)
-     *
-     * @return void
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected function _update_cached_related_model_objs_fks()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Has_Many_Relation) {
-                foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
-                    $fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
-                        $model->get_this_model_name()
-                    );
-                    $related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
-                    if ($related_model_obj_in_cache->ID()) {
-                        $related_model_obj_in_cache->save();
-                    }
-                }
-            }
-        }
-    }
-
-
-    /**
-     * Saves this model object and its NEW cached relations to the database.
-     * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
-     * In order for that to work, we would need to mark model objects as dirty/clean...
-     * because otherwise, there's a potential for infinite looping of saving
-     * Saves the cached related model objects, and ensures the relation between them
-     * and this object and properly setup
-     *
-     * @return int ID of new model object on save; 0 on failure+
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function save_new_cached_related_model_objs()
-    {
-        //make sure this has been saved
-        if (! $this->ID()) {
-            $id = $this->save();
-        } else {
-            $id = $this->ID();
-        }
-        //now save all the NEW cached model objects  (ie they don't exist in the DB)
-        foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[ $relationName ]) {
-                //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
-                //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
-                /* @var $related_model_obj EE_Base_Class */
-                if ($relationObj instanceof EE_Belongs_To_Relation) {
-                    //add a relation to that relation type (which saves the appropriate thing in the process)
-                    //but ONLY if it DOES NOT exist in the DB
-                    $related_model_obj = $this->_model_relations[ $relationName ];
-                    //					if( ! $related_model_obj->ID()){
-                    $this->_add_relation_to($related_model_obj, $relationName);
-                    $related_model_obj->save_new_cached_related_model_objs();
-                    //					}
-                } else {
-                    foreach ($this->_model_relations[ $relationName ] as $related_model_obj) {
-                        //add a relation to that relation type (which saves the appropriate thing in the process)
-                        //but ONLY if it DOES NOT exist in the DB
-                        //						if( ! $related_model_obj->ID()){
-                        $this->_add_relation_to($related_model_obj, $relationName);
-                        $related_model_obj->save_new_cached_related_model_objs();
-                        //						}
-                    }
-                }
-            }
-        }
-        return $id;
-    }
-
-
-    /**
-     * for getting a model while instantiated.
-     *
-     * @return EEM_Base | EEM_CPT_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_model()
-    {
-        if (! $this->_model) {
-            $modelName    = self::_get_model_classname(get_class($this));
-            $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
-        } else {
-            $this->_model->set_timezone($this->_timezone);
-        }
-        return $this->_model;
-    }
-
-
-    /**
-     * @param $props_n_values
-     * @param $classname
-     * @return mixed bool|EE_Base_Class|EEM_CPT_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected static function _get_object_from_entity_mapper($props_n_values, $classname)
-    {
-        //TODO: will not work for Term_Relationships because they have no PK!
-        $primary_id_ref = self::_get_primary_key_name($classname);
-        if (
-            array_key_exists($primary_id_ref, $props_n_values)
-            && ! empty($props_n_values[ $primary_id_ref ])
-        ) {
-            $id = $props_n_values[ $primary_id_ref ];
-            return self::_get_model($classname)->get_from_entity_map($id);
-        }
-        return false;
-    }
-
-
-    /**
-     * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
-     * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
-     * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
-     * we return false.
-     *
-     * @param  array  $props_n_values   incoming array of properties and their values
-     * @param  string $classname        the classname of the child class
-     * @param null    $timezone
-     * @param array   $date_formats     incoming date_formats in an array where the first value is the
-     *                                  date_format and the second value is the time format
-     * @return mixed (EE_Base_Class|bool)
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
-    {
-        $existing = null;
-        $model    = self::_get_model($classname, $timezone);
-        if ($model->has_primary_key_field()) {
-            $primary_id_ref = self::_get_primary_key_name($classname);
-            if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[ $primary_id_ref ])
-            ) {
-                $existing = $model->get_one_by_ID(
-                    $props_n_values[ $primary_id_ref ]
-                );
-            }
-        } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
-            //no primary key on this model, but there's still a matching item in the DB
-            $existing = self::_get_model($classname, $timezone)->get_one_by_ID(
-                self::_get_model($classname, $timezone)
-                    ->get_index_primary_key_string($props_n_values)
-            );
-        }
-        if ($existing) {
-            //set date formats if present before setting values
-            if (! empty($date_formats) && is_array($date_formats)) {
-                $existing->set_date_format($date_formats[0]);
-                $existing->set_time_format($date_formats[1]);
-            } else {
-                //set default formats for date and time
-                $existing->set_date_format(get_option('date_format'));
-                $existing->set_time_format(get_option('time_format'));
-            }
-            foreach ($props_n_values as $property => $field_value) {
-                $existing->set($property, $field_value);
-            }
-            return $existing;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the EEM_*_Model for this class
-     *
-     * @access public now, as this is more convenient
-     * @param      $classname
-     * @param null $timezone
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return EEM_Base
-     */
-    protected static function _get_model($classname, $timezone = null)
-    {
-        //find model for this class
-        if (! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        'What were you thinking calling _get_model(%s)?? You need to specify the class name',
-                        'event_espresso'
-                    ),
-                    $classname
-                )
-            );
-        }
-        $modelName = self::_get_model_classname($classname);
-        return self::_get_model_instance_with_name($modelName, $timezone);
-    }
-
-
-    /**
-     * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
-     *
-     * @param string $model_classname
-     * @param null   $timezone
-     * @return EEM_Base
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    protected static function _get_model_instance_with_name($model_classname, $timezone = null)
-    {
-        $model_classname = str_replace('EEM_', '', $model_classname);
-        $model           = EE_Registry::instance()->load_model($model_classname);
-        $model->set_timezone($timezone);
-        return $model;
-    }
-
-
-    /**
-     * If a model name is provided (eg Registration), gets the model classname for that model.
-     * Also works if a model class's classname is provided (eg EE_Registration).
-     *
-     * @param null $model_name
-     * @return string like EEM_Attendee
-     */
-    private static function _get_model_classname($model_name = null)
-    {
-        if (strpos($model_name, 'EE_') === 0) {
-            $model_classname = str_replace('EE_', 'EEM_', $model_name);
-        } else {
-            $model_classname = 'EEM_' . $model_name;
-        }
-        return $model_classname;
-    }
-
-
-    /**
-     * returns the name of the primary key attribute
-     *
-     * @param null $classname
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return string
-     */
-    protected static function _get_primary_key_name($classname = null)
-    {
-        if (! $classname) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
-                    $classname
-                )
-            );
-        }
-        return self::_get_model($classname)->get_primary_key_field()->get_name();
-    }
-
-
-    /**
-     * Gets the value of the primary key.
-     * If the object hasn't yet been saved, it should be whatever the model field's default was
-     * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
-     * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
-     *
-     * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function ID()
-    {
-        $model = $this->get_model();
-        //now that we know the name of the variable, use a variable variable to get its value and return its
-        if ($model->has_primary_key_field()) {
-            return $this->_fields[ $model->primary_key_name() ];
-        }
-        return $model->get_index_primary_key_string($this->_fields);
-    }
-
-
-    /**
-     * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
-     *
-     * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
-     * @param string $relationName                     eg 'Events','Question',etc.
-     *                                                 an attendee to a group, you also want to specify which role they
-     *                                                 will have in that group. So you would use this parameter to
-     *                                                 specify array('role-column-name'=>'role-id')
-     * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
-     *                                                 allow you to further constrict the relation to being added.
-     *                                                 However, keep in mind that the columns (keys) given must match a
-     *                                                 column on the JOIN table and currently only the HABTM models
-     *                                                 accept these additional conditions.  Also remember that if an
-     *                                                 exact match isn't found for these extra cols/val pairs, then a
-     *                                                 NEW row is created in the join table.
-     * @param null   $cache_id
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @return EE_Base_Class the object the relation was added to
-     */
-    public function _add_relation_to(
-        $otherObjectModelObjectOrID,
-        $relationName,
-        $extra_join_model_fields_n_values = array(),
-        $cache_id = null
-    ) {
-        $model = $this->get_model();
-        //if this thing exists in the DB, save the relation to the DB
-        if ($this->ID()) {
-            $otherObject = $model->add_relationship_to(
-                $this,
-                $otherObjectModelObjectOrID,
-                $relationName,
-                $extra_join_model_fields_n_values
-            );
-            //clear cache so future get_many_related and get_first_related() return new results.
-            $this->clear_cache($relationName, $otherObject, true);
-            if ($otherObject instanceof EE_Base_Class) {
-                $otherObject->clear_cache($model->get_this_model_name(), $this);
-            }
-        } else {
-            //this thing doesn't exist in the DB,  so just cache it
-            if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
-                            'event_espresso'
-                        ),
-                        $otherObjectModelObjectOrID,
-                        get_class($this)
-                    )
-                );
-            }
-            $otherObject = $otherObjectModelObjectOrID;
-            $this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            //fix the reciprocal relation too
-            if ($otherObject->ID()) {
-                //its saved so assumed relations exist in the DB, so we can just
-                //clear the cache so future queries use the updated info in the DB
-                $otherObject->clear_cache(
-                    $model->get_this_model_name(),
-                    null,
-                    true
-                );
-            } else {
-                //it's not saved, so it caches relations like this
-                $otherObject->cache($model->get_this_model_name(), $this);
-            }
-        }
-        return $otherObject;
-    }
-
-
-    /**
-     * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
-     * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
-     * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
-     * from the cache
-     *
-     * @param mixed  $otherObjectModelObjectOrID
-     *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
-     *                to the DB yet
-     * @param string $relationName
-     * @param array  $where_query
-     *                You can optionally include an array of key=>value pairs that allow you to further constrict the
-     *                relation to being added. However, keep in mind that the columns (keys) given must match a column
-     *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
-     *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
-     *                created in the join table.
-     * @return EE_Base_Class the relation was removed from
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObject = $this->get_model()->remove_relationship_to(
-                $this,
-                $otherObjectModelObjectOrID,
-                $relationName,
-                $where_query
-            );
-            $this->clear_cache(
-                $relationName,
-                $otherObject
-            );
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObject = $this->clear_cache(
-                $relationName,
-                $otherObjectModelObjectOrID
-            );
-        }
-        if ($otherObject instanceof EE_Base_Class) {
-            $otherObject->clear_cache(
-                $this->get_model()->get_this_model_name(),
-                $this
-            );
-        }
-        return $otherObject;
-    }
-
-
-    /**
-     * Removes ALL the related things for the $relationName.
-     *
-     * @param string $relationName
-     * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
-     * @return EE_Base_Class
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function _remove_relations($relationName, $where_query_params = array())
-    {
-        if ($this->ID()) {
-            //if this exists in the DB, save the relation change to the DB too
-            $otherObjects = $this->get_model()->remove_relations(
-                $this,
-                $relationName,
-                $where_query_params
-            );
-            $this->clear_cache(
-                $relationName,
-                null,
-                true
-            );
-        } else {
-            //this doesn't exist in the DB, just remove it from the cache
-            $otherObjects = $this->clear_cache(
-                $relationName,
-                null,
-                true
-            );
-        }
-        if (is_array($otherObjects)) {
-            foreach ($otherObjects as $otherObject) {
-                $otherObject->clear_cache(
-                    $this->get_model()->get_this_model_name(),
-                    $this
-                );
-            }
-        }
-        return $otherObjects;
-    }
-
-
-    /**
-     * Gets all the related model objects of the specified type. Eg, if the current class if
-     * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
-     * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
-     * because we want to get even deleted items etc.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class[]     Results not necessarily indexed by IDs, because some results might not have primary
-     *                             keys or might not be saved yet. Consider using EEM_Base::get_IDs() on these
-     *                             results if you want IDs
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_many_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            //this exists in the DB, so get the related things from either the cache or the DB
-            //if there are query parameters, forget about caching the related model objects.
-            if ($query_params) {
-                $related_model_objects = $this->get_model()->get_all_related(
-                    $this,
-                    $relationName,
-                    $query_params
-                );
-            } else {
-                //did we already cache the result of this query?
-                $cached_results = $this->get_all_from_cache($relationName);
-                if (! $cached_results) {
-                    $related_model_objects = $this->get_model()->get_all_related(
-                        $this,
-                        $relationName,
-                        $query_params
-                    );
-                    //if no query parameters were passed, then we got all the related model objects
-                    //for that relation. We can cache them then.
-                    foreach ($related_model_objects as $related_model_object) {
-                        $this->cache($relationName, $related_model_object);
-                    }
-                } else {
-                    $related_model_objects = $cached_results;
-                }
-            }
-        } else {
-            //this doesn't exist in the DB, so just get the related things from the cache
-            $related_model_objects = $this->get_all_from_cache($relationName);
-        }
-        return $related_model_objects;
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
-     * unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name  model_name like 'Event', or 'Registration'
-     * @param array  $query_params   like EEM_Base::get_all's
-     * @param string $field_to_count name of field to count by. By default, uses primary key
-     * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
-     *                               that by the setting $distinct to TRUE;
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
-    {
-        return $this->get_model()->count_related(
-            $this,
-            $relation_name,
-            $query_params,
-            $field_to_count,
-            $distinct
-        );
-    }
-
-
-    /**
-     * Instead of getting the related model objects, simply sums up the values of the specified field.
-     * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
-     *
-     * @param string $relation_name model_name like 'Event', or 'Registration'
-     * @param array  $query_params  like EEM_Base::get_all's
-     * @param string $field_to_sum  name of field to count by.
-     *                              By default, uses primary key
-     *                              (which doesn't make much sense, so you should probably change it)
-     * @return int
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
-    {
-        return $this->get_model()->sum_related(
-            $this,
-            $relation_name,
-            $query_params,
-            $field_to_sum
-        );
-    }
-
-
-    /**
-     * Gets the first (ie, one) related model object of the specified type.
-     *
-     * @param string $relationName key in the model's _model_relations array
-     * @param array  $query_params like EEM_Base::get_all
-     * @return EE_Base_Class (not an array, a single object)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_first_related($relationName, $query_params = array())
-    {
-        $model = $this->get_model();
-        if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
-            //if they've provided some query parameters, don't bother trying to cache the result
-            //also make sure we're not caching the result of get_first_related
-            //on a relation which should have an array of objects (because the cache might have an array of objects)
-            if ($query_params
-                || ! $model->related_settings_for($relationName)
-                     instanceof
-                     EE_Belongs_To_Relation
-            ) {
-                $related_model_object = $model->get_first_related(
-                    $this,
-                    $relationName,
-                    $query_params
-                );
-            } else {
-                //first, check if we've already cached the result of this query
-                $cached_result = $this->get_one_from_cache($relationName);
-                if (! $cached_result) {
-                    $related_model_object = $model->get_first_related(
-                        $this,
-                        $relationName,
-                        $query_params
-                    );
-                    $this->cache($relationName, $related_model_object);
-                } else {
-                    $related_model_object = $cached_result;
-                }
-            }
-        } else {
-            $related_model_object = null;
-            // this doesn't exist in the Db,
-            // but maybe the relation is of type belongs to, and so the related thing might
-            if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
-                $related_model_object = $model->get_first_related(
-                    $this,
-                    $relationName,
-                    $query_params
-                );
-            }
-            // this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
-            // just get what's cached on this object
-            if (! $related_model_object) {
-                $related_model_object = $this->get_one_from_cache($relationName);
-            }
-        }
-        return $related_model_object;
-    }
-
-
-    /**
-     * Does a delete on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) does nothing. If the related model objects are
-     * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
-     * If this model object doesn't exist yet in the DB, just removes its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_related($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related(
-                $this,
-                $relationName,
-                $query_params
-            );
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-            $this->clear_cache($relationName, null, true);
-        }
-        return $count;
-    }
-
-
-    /**
-     * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
-     * the current model object's relation to them. If they can't be deleted (because
-     * of blocking related model objects) just does a soft delete on it instead, if possible.
-     * If the related thing isn't a soft-deletable model object, this function is identical
-     * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
-     *
-     * @param string $relationName
-     * @param array  $query_params like EEM_Base::get_all's
-     * @return int how many deleted (including those soft deleted)
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function delete_related_permanently($relationName, $query_params = array())
-    {
-        if ($this->ID()) {
-            $count = $this->get_model()->delete_related_permanently(
-                $this,
-                $relationName,
-                $query_params
-            );
-        } else {
-            $count = count($this->get_all_from_cache($relationName));
-        }
-        $this->clear_cache($relationName, null, true);
-        return $count;
-    }
-
-
-    /**
-     * is_set
-     * Just a simple utility function children can use for checking if property exists
-     *
-     * @access  public
-     * @param  string $field_name property to check
-     * @return bool                              TRUE if existing,FALSE if not.
-     */
-    public function is_set($field_name)
-    {
-        return isset($this->_fields[ $field_name ]);
-    }
-
-
-    /**
-     * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
-     * EE_Error exception if they don't
-     *
-     * @param  mixed (string|array) $properties properties to check
-     * @throws EE_Error
-     * @return bool                              TRUE if existing, throw EE_Error if not.
-     */
-    protected function _property_exists($properties)
-    {
-        foreach ((array) $properties as $property_name) {
-            //first make sure this property exists
-            if (! $this->_fields[ $property_name ]) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
-                            'event_espresso'
-                        ),
-                        $property_name
-                    )
-                );
-            }
-        }
-        return true;
-    }
-
-
-    /**
-     * This simply returns an array of model fields for this object
-     *
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function model_field_array()
-    {
-        $fields     = $this->get_model()->field_settings(false);
-        $properties = array();
-        //remove prepended underscore
-        foreach ($fields as $field_name => $settings) {
-            $properties[ $field_name ] = $this->get($field_name);
-        }
-        return $properties;
-    }
-
-
-    /**
-     * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
-     * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
-     * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments.
-     * Instead of requiring a plugin to extend the EE_Base_Class
-     * (which works fine is there's only 1 plugin, but when will that happen?)
-     * they can add a hook onto 'filters_hook_espresso__{className}__{methodName}'
-     * (eg, filters_hook_espresso__EE_Answer__my_great_function)
-     * and accepts 2 arguments: the object on which the function was called,
-     * and an array of the original arguments passed to the function.
-     * Whatever their callback function returns will be returned by this function.
-     * Example: in functions.php (or in a plugin):
-     *      add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3);
-     *      function my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
-     *          $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
-     *          return $previousReturnValue.$returnString;
-     *      }
-     * require('EE_Answer.class.php');
-     * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
-     * echo $answer->my_callback('monkeys',100);
-     * //will output "you called my_callback! and passed args:monkeys,100"
-     *
-     * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
-     * @param array  $args       array of original arguments passed to the function
-     * @throws EE_Error
-     * @return mixed whatever the plugin which calls add_filter decides
-     */
-    public function __call($methodName, $args)
-    {
-        $className = get_class($this);
-        $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
-                        'event_espresso'
-                    ),
-                    $methodName,
-                    $className,
-                    $tagName
-                )
-            );
-        }
-        return apply_filters($tagName, null, $this, $args);
-    }
-
-
-    /**
-     * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
-     * A $previous_value can be specified in case there are many meta rows with the same key
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @param mixed  $previous_value
-     * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
-     *                  NOTE: if the values haven't changed, returns 0
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($previous_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if (! $existing_rows_like_that) {
-            return $this->add_extra_meta($meta_key, $meta_value);
-        }
-        foreach ($existing_rows_like_that as $existing_row) {
-            $existing_row->save(array('EXM_value' => $meta_value));
-        }
-        return count($existing_rows_like_that);
-    }
-
-
-    /**
-     * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
-     * no other extra meta for this model object have the same key. Returns TRUE if the
-     * extra meta row was entered, false if not
-     *
-     * @param string  $meta_key
-     * @param mixed   $meta_value
-     * @param boolean $unique
-     * @return boolean
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws ReflectionException
-     */
-    public function add_extra_meta($meta_key, $meta_value, $unique = false)
-    {
-        if ($unique) {
-            $existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
-                array(
-                    array(
-                        'EXM_key'  => $meta_key,
-                        'OBJ_ID'   => $this->ID(),
-                        'EXM_type' => $this->get_model()->get_this_model_name(),
-                    ),
-                )
-            );
-            if ($existing_extra_meta) {
-                return false;
-            }
-        }
-        $new_extra_meta = EE_Extra_Meta::new_instance(
-            array(
-                'EXM_key'   => $meta_key,
-                'EXM_value' => $meta_value,
-                'OBJ_ID'    => $this->ID(),
-                'EXM_type'  => $this->get_model()->get_this_model_name(),
-            )
-        );
-        $new_extra_meta->save();
-        return true;
-    }
-
-
-    /**
-     * Deletes all the extra meta rows for this record as specified by key. If $meta_value
-     * is specified, only deletes extra meta records with that value.
-     *
-     * @param string $meta_key
-     * @param mixed  $meta_value
-     * @return int number of extra meta rows deleted
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_extra_meta($meta_key, $meta_value = null)
-    {
-        $query_params = array(
-            array(
-                'EXM_key'  => $meta_key,
-                'OBJ_ID'   => $this->ID(),
-                'EXM_type' => $this->get_model()->get_this_model_name(),
-            ),
-        );
-        if ($meta_value !== null) {
-            $query_params[0]['EXM_value'] = $meta_value;
-        }
-        return EEM_Extra_Meta::instance()->delete($query_params);
-    }
-
-
-    /**
-     * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
-     * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
-     * You can specify $default is case you haven't found the extra meta
-     *
-     * @param string  $meta_key
-     * @param boolean $single
-     * @param mixed   $default if we don't find anything, what should we return?
-     * @return mixed single value if $single; array if ! $single
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function get_extra_meta($meta_key, $single = false, $default = null)
-    {
-        if ($single) {
-            $result = $this->get_first_related(
-                'Extra_Meta',
-                array(array('EXM_key' => $meta_key))
-            );
-            if ($result instanceof EE_Extra_Meta) {
-                return $result->value();
-            }
-        } else {
-            $results = $this->get_many_related(
-                'Extra_Meta',
-                array(array('EXM_key' => $meta_key))
-            );
-            if ($results) {
-                $values = array();
-                foreach ($results as $result) {
-                    if ($result instanceof EE_Extra_Meta) {
-                        $values[ $result->ID() ] = $result->value();
-                    }
-                }
-                return $values;
-            }
-        }
-        //if nothing discovered yet return default.
-        return apply_filters(
-            'FHEE__EE_Base_Class__get_extra_meta__default_value',
-            $default,
-            $meta_key,
-            $single,
-            $this
-        );
-    }
-
-
-    /**
-     * Returns a simple array of all the extra meta associated with this model object.
-     * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
-     * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
-     * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
-     * If $one_of_each_key is false, it will return an array with the top-level keys being
-     * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
-     * finally the extra meta's value as each sub-value. (eg
-     * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
-     *
-     * @param boolean $one_of_each_key
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function all_extra_meta_array($one_of_each_key = true)
-    {
-        $return_array = array();
-        if ($one_of_each_key) {
-            $extra_meta_objs = $this->get_many_related(
-                'Extra_Meta',
-                array('group_by' => 'EXM_key')
-            );
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
-                }
-            }
-        } else {
-            $extra_meta_objs = $this->get_many_related('Extra_Meta');
-            foreach ($extra_meta_objs as $extra_meta_obj) {
-                if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if (! isset($return_array[ $extra_meta_obj->key() ])) {
-                        $return_array[ $extra_meta_obj->key() ] = array();
-                    }
-                    $return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
-                }
-            }
-        }
-        return $return_array;
-    }
-
-
-    /**
-     * Gets a pretty nice displayable nice for this model object. Often overridden
-     *
-     * @return string
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function name()
-    {
-        //find a field that's not a text field
-        $field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
-        if ($field_we_can_use) {
-            return $this->get($field_we_can_use->get_name());
-        }
-        $first_few_properties = $this->model_field_array();
-        $first_few_properties = array_slice($first_few_properties, 0, 3);
-        $name_parts           = array();
-        foreach ($first_few_properties as $name => $value) {
-            $name_parts[] = "$name:$value";
-        }
-        return implode(',', $name_parts);
-    }
-
-
-    /**
-     * in_entity_map
-     * Checks if this model object has been proven to already be in the entity map
-     *
-     * @return boolean
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function in_entity_map()
-    {
-        // well, if we looked, did we find it in the entity map?
-        return $this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this;
-    }
-
-
-    /**
-     * refresh_from_db
-     * Makes sure the fields and values on this model object are in-sync with what's in the database.
-     *
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error if this model object isn't in the entity mapper (because then you should
-     * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
-     */
-    public function refresh_from_db()
-    {
-        if ($this->ID() && $this->in_entity_map()) {
-            $this->get_model()->refresh_entity_map_from_db($this->ID());
-        } else {
-            //if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
-            //if it has an ID but it's not in the map, and you're asking me to refresh it
-            //that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
-            //absolutely nothing in it for this ID
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
-                            'event_espresso'),
-                        $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
-                    )
-                );
-            }
-        }
-    }
-
-
-    /**
-     * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
-     * (probably a bad assumption they have made, oh well)
-     *
-     * @return string
-     */
-    public function __toString()
-    {
-        try {
-            return sprintf('%s (%s)', $this->name(), $this->ID());
-        } catch (Exception $e) {
-            EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
-            return '';
-        }
-    }
-
-
-    /**
-     * Clear related model objects if they're already in the DB, because otherwise when we
-     * UN-serialize this model object we'll need to be careful to add them to the entity map.
-     * This means if we have made changes to those related model objects, and want to unserialize
-     * the this model object on a subsequent request, changes to those related model objects will be lost.
-     * Instead, those related model objects should be directly serialized and stored.
-     * Eg, the following won't work:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $reg = get_option( 'my_option' );
-     * $reg->attendee()->save();
-     * And would need to be replace with:
-     * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
-     * $att = $reg->attendee();
-     * $att->set( 'ATT_fname', 'Dirk' );
-     * update_option( 'my_option', serialize( $reg ) );
-     * //END REQUEST
-     * //START NEXT REQUEST
-     * $att = get_option( 'my_option' );
-     * $att->save();
-     *
-     * @return array
-     * @throws ReflectionException
-     * @throws InvalidArgumentException
-     * @throws InvalidInterfaceException
-     * @throws InvalidDataTypeException
-     * @throws EE_Error
-     */
-    public function __sleep()
-    {
-        $model = $this->get_model();
-        foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
-                if (
-                    $this->get_one_from_cache($relation_name) instanceof $classname
-                    && $this->get_one_from_cache($relation_name)->ID()
-                ) {
-                    $this->clear_cache(
-                        $relation_name,
-                        $this->get_one_from_cache($relation_name)->ID()
-                    );
-                }
-            }
-        }
-        $this->_props_n_values_provided_in_constructor = array();
-        $properties_to_serialize                       = get_object_vars($this);
-        //don't serialize the model. It's big and that risks recursion
-        unset($properties_to_serialize['_model']);
-        return array_keys($properties_to_serialize);
-    }
-
-
-    /**
-     * restore _props_n_values_provided_in_constructor
-     * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
-     * and therefore should NOT be used to determine if state change has occurred since initial construction.
-     * At best, you would only be able to detect if state change has occurred during THIS request.
-     */
-    public function __wakeup()
-    {
-        $this->_props_n_values_provided_in_constructor = $this->_fields;
-    }
+	/**
+	 * This is an array of the original properties and values provided during construction
+	 * of this model object. (keys are model field names, values are their values).
+	 * This list is important to remember so that when we are merging data from the db, we know
+	 * which values to override and which to not override.
+	 *
+	 * @var array
+	 */
+	protected $_props_n_values_provided_in_constructor;
+
+	/**
+	 * Timezone
+	 * This gets set by the "set_timezone()" method so that we know what timezone incoming strings|timestamps are in.
+	 * This can also be used before a get to set what timezone you want strings coming out of the object to be in.  NOT
+	 * all EE_Base_Class child classes use this property but any that use a EE_Datetime_Field data type will have
+	 * access to it.
+	 *
+	 * @var string
+	 */
+	protected $_timezone;
+
+	/**
+	 * date format
+	 * pattern or format for displaying dates
+	 *
+	 * @var string $_dt_frmt
+	 */
+	protected $_dt_frmt;
+
+	/**
+	 * time format
+	 * pattern or format for displaying time
+	 *
+	 * @var string $_tm_frmt
+	 */
+	protected $_tm_frmt;
+
+	/**
+	 * This property is for holding a cached array of object properties indexed by property name as the key.
+	 * The purpose of this is for setting a cache on properties that may have calculated values after a
+	 * prepare_for_get.  That way the cache can be checked first and the calculated property returned instead of having
+	 * to recalculate. Used by _set_cached_property() and _get_cached_property() methods.
+	 *
+	 * @var array
+	 */
+	protected $_cached_properties = array();
+
+	/**
+	 * An array containing keys of the related model, and values are either an array of related mode objects or a
+	 * single
+	 * related model object. see the model's _model_relations. The keys should match those specified. And if the
+	 * relation is of type EE_Belongs_To (or one of its children), then there should only be ONE related model object,
+	 * all others have an array)
+	 *
+	 * @var array
+	 */
+	protected $_model_relations = array();
+
+	/**
+	 * Array where keys are field names (see the model's _fields property) and values are their values. To see what
+	 * their types should be, look at what that field object returns on its prepare_for_get and prepare_for_set methods)
+	 *
+	 * @var array
+	 */
+	protected $_fields = array();
+
+	/**
+	 * @var boolean indicating whether or not this model object is intended to ever be saved
+	 * For example, we might create model objects intended to only be used for the duration
+	 * of this request and to be thrown away, and if they were accidentally saved
+	 * it would be a bug.
+	 */
+	protected $_allow_persist = true;
+
+	/**
+	 * @var boolean indicating whether or not this model object's properties have changed since construction
+	 */
+	protected $_has_changes = false;
+
+	/**
+	 * @var EEM_Base
+	 */
+	protected $_model;
+
+	/**
+	 * This is a cache of results from custom selections done on a query that constructs this entity. The only purpose
+	 * for these values is for retrieval of the results, they are not further queryable and they are not persisted to
+	 * the db.  They also do not automatically update if there are any changes to the data that produced their results.
+	 * The format is a simple array of field_alias => field_value.  So for instance if a custom select was something
+	 * like,  "Select COUNT(Registration.REG_ID) as Registration_Count ...", then the resulting value will be in this
+	 * array as:
+	 * array(
+	 *  'Registration_Count' => 24
+	 * );
+	 * Note: if the custom select configuration for the query included a data type, the value will be in the data type
+	 * provided for the query (@see EventEspresso\core\domain\values\model\CustomSelects::__construct phpdocs for more
+	 * info)
+	 *
+	 * @var array
+	 */
+	protected $custom_selection_results = array();
+
+
+	/**
+	 * basic constructor for Event Espresso classes, performs any necessary initialization, and verifies it's children
+	 * play nice
+	 *
+	 * @param array   $fieldValues                             where each key is a field (ie, array key in the 2nd
+	 *                                                         layer of the model's _fields array, (eg, EVT_ID,
+	 *                                                         TXN_amount, QST_name, etc) and values are their values
+	 * @param boolean $bydb                                    a flag for setting if the class is instantiated by the
+	 *                                                         corresponding db model or not.
+	 * @param string  $timezone                                indicate what timezone you want any datetime fields to
+	 *                                                         be in when instantiating a EE_Base_Class object.
+	 * @param array   $date_formats                            An array of date formats to set on construct where first
+	 *                                                         value is the date_format and second value is the time
+	 *                                                         format.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct($fieldValues = array(), $bydb = false, $timezone = '', $date_formats = array())
+	{
+		$className = get_class($this);
+		do_action("AHEE__{$className}__construct", $this, $fieldValues);
+		$model        = $this->get_model();
+		$model_fields = $model->field_settings(false);
+		// ensure $fieldValues is an array
+		$fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
+		// verify client code has not passed any invalid field names
+		foreach ($fieldValues as $field_name => $field_value) {
+			if (! isset($model_fields[ $field_name ])) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Invalid field (%s) passed to constructor of %s. Allowed fields are :%s',
+							'event_espresso'
+						),
+						$field_name,
+						get_class($this),
+						implode(', ', array_keys($model_fields))
+					)
+				);
+			}
+		}
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		if (! empty($date_formats) && is_array($date_formats)) {
+			list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
+		} else {
+			//set default formats for date and time
+			$this->_dt_frmt = (string) get_option('date_format', 'Y-m-d');
+			$this->_tm_frmt = (string) get_option('time_format', 'g:i a');
+		}
+		//if db model is instantiating
+		if ($bydb) {
+			//client code has indicated these field values are from the database
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set_from_db(
+					$fieldName,
+					isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null
+				);
+			}
+		} else {
+			//we're constructing a brand
+			//new instance of the model object. Generally, this means we'll need to do more field validation
+			foreach ($model_fields as $fieldName => $field) {
+				$this->set(
+					$fieldName,
+					isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null, true
+				);
+			}
+		}
+		//remember what values were passed to this constructor
+		$this->_props_n_values_provided_in_constructor = $fieldValues;
+		//remember in entity mapper
+		if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
+			$model->add_to_entity_map($this);
+		}
+		//setup all the relations
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$this->_model_relations[ $relation_name ] = null;
+			} else {
+				$this->_model_relations[ $relation_name ] = array();
+			}
+		}
+		/**
+		 * Action done at the end of each model object construction
+		 *
+		 * @param EE_Base_Class $this the model object just created
+		 */
+		do_action('AHEE__EE_Base_Class__construct__finished', $this);
+	}
+
+
+	/**
+	 * Gets whether or not this model object is allowed to persist/be saved to the database.
+	 *
+	 * @return boolean
+	 */
+	public function allow_persist()
+	{
+		return $this->_allow_persist;
+	}
+
+
+	/**
+	 * Sets whether or not this model object should be allowed to be saved to the DB.
+	 * Normally once this is set to FALSE you wouldn't set it back to TRUE, unless
+	 * you got new information that somehow made you change your mind.
+	 *
+	 * @param boolean $allow_persist
+	 * @return boolean
+	 */
+	public function set_allow_persist($allow_persist)
+	{
+		return $this->_allow_persist = $allow_persist;
+	}
+
+
+	/**
+	 * Gets the field's original value when this object was constructed during this request.
+	 * This can be helpful when determining if a model object has changed or not
+	 *
+	 * @param string $field_name
+	 * @return mixed|null
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_original($field_name)
+	{
+		if (isset($this->_props_n_values_provided_in_constructor[ $field_name ])
+			&& $field_settings = $this->get_model()->field_settings_for($field_name)
+		) {
+			return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
+		}
+		return null;
+	}
+
+
+	/**
+	 * @param EE_Base_Class $obj
+	 * @return string
+	 */
+	public function get_class($obj)
+	{
+		return get_class($obj);
+	}
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param    string $field_name
+	 * @param    mixed  $field_value
+	 * @param bool      $use_default
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function set($field_name, $field_value, $use_default = false)
+	{
+		// if not using default and nothing has changed, and object has already been setup (has ID),
+		// then don't do anything
+		if (
+			! $use_default
+			&& $this->_fields[ $field_name ] === $field_value
+			&& $this->ID()
+		) {
+			return;
+		}
+		$model              = $this->get_model();
+		$this->_has_changes = true;
+		$field_obj          = $model->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//			if ( method_exists( $field_obj, 'set_timezone' )) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				$field_obj->set_date_format($this->_dt_frmt);
+				$field_obj->set_time_format($this->_tm_frmt);
+			}
+			$holder_of_value = $field_obj->prepare_for_set($field_value);
+			//should the value be null?
+			if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
+				$this->_fields[ $field_name ] = $field_obj->get_default_value();
+				/**
+				 * To save having to refactor all the models, if a default value is used for a
+				 * EE_Datetime_Field, and that value is not null nor is it a DateTime
+				 * object.  Then let's do a set again to ensure that it becomes a DateTime
+				 * object.
+				 *
+				 * @since 4.6.10+
+				 */
+				if (
+					$field_obj instanceof EE_Datetime_Field
+					&& $this->_fields[ $field_name ] !== null
+					&& ! $this->_fields[ $field_name ] instanceof DateTime
+				) {
+					empty($this->_fields[ $field_name ])
+						? $this->set($field_name, time())
+						: $this->set($field_name, $this->_fields[ $field_name ]);
+				}
+			} else {
+				$this->_fields[ $field_name ] = $holder_of_value;
+			}
+			//if we're not in the constructor...
+			//now check if what we set was a primary key
+			if (
+				//note: props_n_values_provided_in_constructor is only set at the END of the constructor
+				$this->_props_n_values_provided_in_constructor
+				&& $field_value
+				&& $field_name === $model->primary_key_name()
+			) {
+				//if so, we want all this object's fields to be filled either with
+				//what we've explicitly set on this model
+				//or what we have in the db
+				// echo "setting primary key!";
+				$fields_on_model = self::_get_model(get_class($this))->field_settings();
+				$obj_in_db       = self::_get_model(get_class($this))->get_one_by_ID($field_value);
+				foreach ($fields_on_model as $field_obj) {
+					if (! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+						&& $field_obj->get_name() !== $field_name
+					) {
+						$this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
+					}
+				}
+				//oh this model object has an ID? well make sure its in the entity mapper
+				$model->add_to_entity_map($this);
+			}
+			//let's unset any cache for this field_name from the $_cached_properties property.
+			$this->_clear_cached_property($field_name);
+		} else {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'A valid EE_Model_Field_Base could not be found for the given field name: %s',
+						'event_espresso'
+					),
+					$field_name
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * Set custom select values for model.
+	 *
+	 * @param array $custom_select_values
+	 */
+	public function setCustomSelectsValues(array $custom_select_values)
+	{
+		$this->custom_selection_results = $custom_select_values;
+	}
+
+
+	/**
+	 * Returns the custom select value for the provided alias if its set.
+	 * If not set, returns null.
+	 *
+	 * @param string $alias
+	 * @return string|int|float|null
+	 */
+	public function getCustomSelect($alias)
+	{
+		return isset($this->custom_selection_results[ $alias ])
+			? $this->custom_selection_results[ $alias ]
+			: null;
+	}
+
+
+	/**
+	 * This sets the field value on the db column if it exists for the given $column_name or
+	 * saves it to EE_Extra_Meta if the given $column_name does not match a db column.
+	 *
+	 * @see EE_message::get_column_value for related documentation on the necessity of this method.
+	 * @param string $field_name  Must be the exact column name.
+	 * @param mixed  $field_value The value to set.
+	 * @return int|bool @see EE_Base_Class::update_extra_meta() for return docs.
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_field_or_extra_meta($field_name, $field_value)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$this->set($field_name, $field_value);
+			return true;
+		}
+		//ensure this object is saved first so that extra meta can be properly related.
+		$this->save();
+		return $this->update_extra_meta($field_name, $field_value);
+	}
+
+
+	/**
+	 * This retrieves the value of the db column set on this class or if that's not present
+	 * it will attempt to retrieve from extra_meta if found.
+	 * Example Usage:
+	 * Via EE_Message child class:
+	 * Due to the dynamic nature of the EE_messages system, EE_messengers will always have a "to",
+	 * "from", "subject", and "content" field (as represented in the EE_Message schema), however they may
+	 * also have additional main fields specific to the messenger.  The system accommodates those extra
+	 * fields through the EE_Extra_Meta table.  This method allows for EE_messengers to retrieve the
+	 * value for those extra fields dynamically via the EE_message object.
+	 *
+	 * @param  string $field_name expecting the fully qualified field name.
+	 * @return mixed|null  value for the field if found.  null if not found.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_field_or_extra_meta($field_name)
+	{
+		if ($this->get_model()->has_field($field_name)) {
+			$column_value = $this->get($field_name);
+		} else {
+			//This isn't a column in the main table, let's see if it is in the extra meta.
+			$column_value = $this->get_extra_meta($field_name, true, null);
+		}
+		return $column_value;
+	}
+
+
+	/**
+	 * See $_timezone property for description of what the timezone property is for.  This SETS the timezone internally
+	 * for being able to reference what timezone we are running conversions on when converting TO the internal timezone
+	 * (UTC Unix Timestamp) for the object OR when converting FROM the internal timezone (UTC Unix Timestamp). This is
+	 * available to all child classes that may be using the EE_Datetime_Field for a field data type.
+	 *
+	 * @access public
+	 * @param string $timezone A valid timezone string as described by @link http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_timezone($timezone = '')
+	{
+		$this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
+		//make sure we clear all cached properties because they won't be relevant now
+		$this->_clear_cached_properties();
+		//make sure we update field settings and the date for all EE_Datetime_Fields
+		$model_fields = $this->get_model()->field_settings(false);
+		foreach ($model_fields as $field_name => $field_obj) {
+			if ($field_obj instanceof EE_Datetime_Field) {
+				$field_obj->set_timezone($this->_timezone);
+				if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
+					$this->_fields[ $field_name ]->setTimezone(new DateTimeZone($this->_timezone));
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone()
+	{
+		return $this->_timezone;
+	}
+
+
+	/**
+	 * This sets the internal date format to what is sent in to be used as the new default for the class
+	 * internally instead of wp set date format options
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_date_format($format)
+	{
+		$this->_dt_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+	/**
+	 * This sets the internal time format string to what is sent in to be used as the new default for the
+	 * class internally instead of wp set time format options.
+	 *
+	 * @since 4.6
+	 * @param string $format should be a format recognizable by PHP date() functions.
+	 */
+	public function set_time_format($format)
+	{
+		$this->_tm_frmt = $format;
+		//clear cached_properties because they won't be relevant now.
+		$this->_clear_cached_properties();
+	}
+
+
+	/**
+	 * This returns the current internal set format for the date and time formats.
+	 *
+	 * @param bool $full           if true (default), then return the full format.  Otherwise will return an array
+	 *                             where the first value is the date format and the second value is the time format.
+	 * @return mixed string|array
+	 */
+	public function get_format($full = true)
+	{
+		return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+	}
+
+
+	/**
+	 * cache
+	 * stores the passed model object on the current model object.
+	 * In certain circumstances, we can use this cached model object instead of querying for another one entirely.
+	 *
+	 * @param string        $relationName    one of the keys in the _model_relations array on the model. Eg
+	 *                                       'Registration' associated with this model object
+	 * @param EE_Base_Class $object_to_cache that has a relation to this model object. (Eg, if this is a Transaction,
+	 *                                       that could be a payment or a registration)
+	 * @param null          $cache_id        a string or number that will be used as the key for any Belongs_To_Many
+	 *                                       items which will be stored in an array on this object
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return mixed    index into cache, or just TRUE if the relation is of type Belongs_To (because there's only one
+	 *                                       related thing, no array)
+	 */
+	public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
+	{
+		// its entirely possible that there IS no related object yet in which case there is nothing to cache.
+		if (! $object_to_cache instanceof EE_Base_Class) {
+			return false;
+		}
+		// also get "how" the object is related, or throw an error
+		if (! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		// how many things are related ?
+		if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			// if it's a "belongs to" relationship, then there's only one related model object
+			// eg, if this is a registration, there's only 1 attendee for it
+			// so for these model objects just set it to be cached
+			$this->_model_relations[ $relationName ] = $object_to_cache;
+			$return                                  = true;
+		} else {
+			// otherwise, this is the "many" side of a one to many relationship,
+			// so we'll add the object to the array of related objects for that type.
+			// eg: if this is an event, there are many registrations for that event,
+			// so we cache the registrations in an array
+			if (! is_array($this->_model_relations[ $relationName ])) {
+				// if for some reason, the cached item is a model object,
+				// then stick that in the array, otherwise start with an empty array
+				$this->_model_relations[ $relationName ] = $this->_model_relations[ $relationName ]
+														   instanceof
+														   EE_Base_Class
+					? array($this->_model_relations[ $relationName ]) : array();
+			}
+			// first check for a cache_id which is normally empty
+			if (! empty($cache_id)) {
+				// if the cache_id exists, then it means we are purposely trying to cache this
+				// with a known key that can then be used to retrieve the object later on
+				$this->_model_relations[ $relationName ][ $cache_id ] = $object_to_cache;
+				$return                                               = $cache_id;
+			} elseif ($object_to_cache->ID()) {
+				// OR the cached object originally came from the db, so let's just use it's PK for an ID
+				$this->_model_relations[ $relationName ][ $object_to_cache->ID() ] = $object_to_cache;
+				$return                                                            = $object_to_cache->ID();
+			} else {
+				// OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
+				$this->_model_relations[ $relationName ][] = $object_to_cache;
+				// move the internal pointer to the end of the array
+				end($this->_model_relations[ $relationName ]);
+				// and grab the key so that we can return it
+				$return = key($this->_model_relations[ $relationName ]);
+			}
+		}
+		return $return;
+	}
+
+
+	/**
+	 * For adding an item to the cached_properties property.
+	 *
+	 * @access protected
+	 * @param string      $fieldname the property item the corresponding value is for.
+	 * @param mixed       $value     The value we are caching.
+	 * @param string|null $cache_type
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_cached_property($fieldname, $value, $cache_type = null)
+	{
+		//first make sure this property exists
+		$this->get_model()->field_settings_for($fieldname);
+		$cache_type                                            = empty($cache_type) ? 'standard' : $cache_type;
+		$this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
+	}
+
+
+	/**
+	 * This returns the value cached property if it exists OR the actual property value if the cache doesn't exist.
+	 * This also SETS the cache if we return the actual property!
+	 *
+	 * @param string $fieldname        the name of the property we're trying to retrieve
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref  This allows the user to specify an extra cache ref for the given property
+	 *                                 (in cases where the same property may be used for different outputs
+	 *                                 - i.e. datetime, money etc.)
+	 *                                 It can also accept certain pre-defined "schema" strings
+	 *                                 to define how to output the property.
+	 *                                 see the field's prepare_for_pretty_echoing for what strings can be used
+	 * @return mixed                   whatever the value for the property is we're retrieving
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _get_cached_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		//verify the field exists
+		$model = $this->get_model();
+		$model->field_settings_for($fieldname);
+		$cache_type = $pretty ? 'pretty' : 'standard';
+		$cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
+		if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
+			return $this->_cached_properties[ $fieldname ][ $cache_type ];
+		}
+		$value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
+		$this->_set_cached_property($fieldname, $value, $cache_type);
+		return $value;
+	}
+
+
+	/**
+	 * If the cache didn't fetch the needed item, this fetches it.
+	 *
+	 * @param string $fieldname
+	 * @param bool   $pretty
+	 * @param string $extra_cache_ref
+	 * @return mixed
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_fresh_property($fieldname, $pretty = false, $extra_cache_ref = null)
+	{
+		$field_obj = $this->get_model()->field_settings_for($fieldname);
+		// If this is an EE_Datetime_Field we need to make sure timezone, formats, and output are correct
+		if ($field_obj instanceof EE_Datetime_Field) {
+			$this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
+		}
+		if (! isset($this->_fields[ $fieldname ])) {
+			$this->_fields[ $fieldname ] = null;
+		}
+		$value = $pretty
+			? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
+			: $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
+		return $value;
+	}
+
+
+	/**
+	 * set timezone, formats, and output for EE_Datetime_Field objects
+	 *
+	 * @param \EE_Datetime_Field $datetime_field
+	 * @param bool               $pretty
+	 * @param null               $date_or_time
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _prepare_datetime_field(
+		EE_Datetime_Field $datetime_field,
+		$pretty = false,
+		$date_or_time = null
+	) {
+		$datetime_field->set_timezone($this->_timezone);
+		$datetime_field->set_date_format($this->_dt_frmt, $pretty);
+		$datetime_field->set_time_format($this->_tm_frmt, $pretty);
+		//set the output returned
+		switch ($date_or_time) {
+			case 'D' :
+				$datetime_field->set_date_time_output('date');
+				break;
+			case 'T' :
+				$datetime_field->set_date_time_output('time');
+				break;
+			default :
+				$datetime_field->set_date_time_output();
+		}
+	}
+
+
+	/**
+	 * This just takes care of clearing out the cached_properties
+	 *
+	 * @return void
+	 */
+	protected function _clear_cached_properties()
+	{
+		$this->_cached_properties = array();
+	}
+
+
+	/**
+	 * This just clears out ONE property if it exists in the cache
+	 *
+	 * @param  string $property_name the property to remove if it exists (from the _cached_properties array)
+	 * @return void
+	 */
+	protected function _clear_cached_property($property_name)
+	{
+		if (isset($this->_cached_properties[ $property_name ])) {
+			unset($this->_cached_properties[ $property_name ]);
+		}
+	}
+
+
+	/**
+	 * Ensures that this related thing is a model object.
+	 *
+	 * @param mixed  $object_or_id EE_base_Class/int/string either a related model object, or its ID
+	 * @param string $model_name   name of the related thing, eg 'Attendee',
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function ensure_related_thing_is_model_obj($object_or_id, $model_name)
+	{
+		$other_model_instance = self::_get_model_instance_with_name(
+			self::_get_model_classname($model_name),
+			$this->_timezone
+		);
+		return $other_model_instance->ensure_is_obj($object_or_id);
+	}
+
+
+	/**
+	 * Forgets the cached model of the given relation Name. So the next time we request it,
+	 * we will fetch it again from the database. (Handy if you know it's changed somehow).
+	 * If a specific object is supplied, and the relationship to it is either a HasMany or HABTM,
+	 * then only remove that one object from our cached array. Otherwise, clear the entire list
+	 *
+	 * @param string $relationName                         one of the keys in the _model_relations array on the model.
+	 *                                                     Eg 'Registration'
+	 * @param mixed  $object_to_remove_or_index_into_array or an index into the array of cached things, or NULL
+	 *                                                     if you intend to use $clear_all = TRUE, or the relation only
+	 *                                                     has 1 object anyways (ie, it's a BelongsToRelation)
+	 * @param bool   $clear_all                            This flags clearing the entire cache relation property if
+	 *                                                     this is HasMany or HABTM.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return EE_Base_Class | boolean from which was cleared from the cache, or true if we requested to remove a
+	 *                                                     relation from all
+	 */
+	public function clear_cache($relationName, $object_to_remove_or_index_into_array = null, $clear_all = false)
+	{
+		$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+		$index_in_cache        = '';
+		if (! $relationship_to_model) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
+					$relationName,
+					get_class($this)
+				)
+			);
+		}
+		if ($clear_all) {
+			$obj_removed                             = true;
+			$this->_model_relations[ $relationName ] = null;
+		} elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+			$obj_removed                             = $this->_model_relations[ $relationName ];
+			$this->_model_relations[ $relationName ] = null;
+		} else {
+			if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
+				&& $object_to_remove_or_index_into_array->ID()
+			) {
+				$index_in_cache = $object_to_remove_or_index_into_array->ID();
+				if (is_array($this->_model_relations[ $relationName ])
+					&& ! isset($this->_model_relations[ $relationName ][ $index_in_cache ])
+				) {
+					$index_found_at = null;
+					//find this object in the array even though it has a different key
+					foreach ($this->_model_relations[ $relationName ] as $index => $obj) {
+						/** @noinspection TypeUnsafeComparisonInspection */
+						if (
+							$obj instanceof EE_Base_Class
+							&& (
+								$obj == $object_to_remove_or_index_into_array
+								|| $obj->ID() === $object_to_remove_or_index_into_array->ID()
+							)
+						) {
+							$index_found_at = $index;
+							break;
+						}
+					}
+					if ($index_found_at) {
+						$index_in_cache = $index_found_at;
+					} else {
+						//it wasn't found. huh. well obviously it doesn't need to be removed from teh cache
+						//if it wasn't in it to begin with. So we're done
+						return $object_to_remove_or_index_into_array;
+					}
+				}
+			} elseif ($object_to_remove_or_index_into_array instanceof EE_Base_Class) {
+				//so they provided a model object, but it's not yet saved to the DB... so let's go hunting for it!
+				foreach ($this->get_all_from_cache($relationName) as $index => $potentially_obj_we_want) {
+					/** @noinspection TypeUnsafeComparisonInspection */
+					if ($potentially_obj_we_want == $object_to_remove_or_index_into_array) {
+						$index_in_cache = $index;
+					}
+				}
+			} else {
+				$index_in_cache = $object_to_remove_or_index_into_array;
+			}
+			//supposedly we've found it. But it could just be that the client code
+			//provided a bad index/object
+			if (isset($this->_model_relations[ $relationName ][ $index_in_cache ])) {
+				$obj_removed = $this->_model_relations[ $relationName ][ $index_in_cache ];
+				unset($this->_model_relations[ $relationName ][ $index_in_cache ]);
+			} else {
+				//that thing was never cached anyways.
+				$obj_removed = null;
+			}
+		}
+		return $obj_removed;
+	}
+
+
+	/**
+	 * update_cache_after_object_save
+	 * Allows a cached item to have it's cache ID (within the array of cached items) reset using the new ID it has
+	 * obtained after being saved to the db
+	 *
+	 * @param string        $relationName       - the type of object that is cached
+	 * @param EE_Base_Class $newly_saved_object - the newly saved object to be re-cached
+	 * @param string        $current_cache_id   - the ID that was used when originally caching the object
+	 * @return boolean TRUE on success, FALSE on fail
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function update_cache_after_object_save(
+		$relationName,
+		EE_Base_Class $newly_saved_object,
+		$current_cache_id = ''
+	) {
+		// verify that incoming object is of the correct type
+		$obj_class = 'EE_' . $relationName;
+		if ($newly_saved_object instanceof $obj_class) {
+			/* @type EE_Base_Class $newly_saved_object */
+			// now get the type of relation
+			$relationship_to_model = $this->get_model()->related_settings_for($relationName);
+			// if this is a 1:1 relationship
+			if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
+				// then just replace the cached object with the newly saved object
+				$this->_model_relations[ $relationName ] = $newly_saved_object;
+				return true;
+				// or if it's some kind of sordid feral polyamorous relationship...
+			}
+			if (is_array($this->_model_relations[ $relationName ])
+					  && isset($this->_model_relations[ $relationName ][ $current_cache_id ])
+			) {
+				// then remove the current cached item
+				unset($this->_model_relations[ $relationName ][ $current_cache_id ]);
+				// and cache the newly saved object using it's new ID
+				$this->_model_relations[ $relationName ][ $newly_saved_object->ID() ] = $newly_saved_object;
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @return EE_Base_Class
+	 */
+	public function get_one_from_cache($relationName)
+	{
+		$cached_array_or_object = isset($this->_model_relations[ $relationName ])
+			? $this->_model_relations[ $relationName ]
+			: null;
+		if (is_array($cached_array_or_object)) {
+			return array_shift($cached_array_or_object);
+		}
+		return $cached_array_or_object;
+	}
+
+
+	/**
+	 * Fetches a single EE_Base_Class on that relation. (If the relation is of type
+	 * BelongsTo, it will only ever have 1 object. However, other relations could have an array of objects)
+	 *
+	 * @param string $relationName
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return EE_Base_Class[] NOT necessarily indexed by primary keys
+	 */
+	public function get_all_from_cache($relationName)
+	{
+		$objects = isset($this->_model_relations[ $relationName ]) ? $this->_model_relations[ $relationName ] : array();
+		// if the result is not an array, but exists, make it an array
+		$objects = is_array($objects) ? $objects : array($objects);
+		//bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
+		//basically, if this model object was stored in the session, and these cached model objects
+		//already have IDs, let's make sure they're in their model's entity mapper
+		//otherwise we will have duplicates next time we call
+		// EE_Registry::instance()->load_model( $relationName )->get_one_by_ID( $result->ID() );
+		$model = EE_Registry::instance()->load_model($relationName);
+		foreach ($objects as $model_object) {
+			if ($model instanceof EEM_Base && $model_object instanceof EE_Base_Class) {
+				//ensure its in the map if it has an ID; otherwise it will be added to the map when its saved
+				if ($model_object->ID()) {
+					$model->add_to_entity_map($model_object);
+				}
+			} else {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Error retrieving related model objects. Either $1%s is not a model or $2%s is not a model object',
+							'event_espresso'
+						),
+						$relationName,
+						gettype($model_object)
+					)
+				);
+			}
+		}
+		return $objects;
+	}
+
+
+	/**
+	 * Returns the next x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function next_x($field_to_order_by = null, $limit = 1, $query_params = array(), $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->next_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the previous x number of EE_Base_Class objects in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param int   $limit              How many objects to return.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class[]
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function previous_x(
+		$field_to_order_by = null,
+		$limit = 1,
+		$query_params = array(),
+		$columns_to_select = null
+	) {
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->previous_x($current_value, $field, $limit, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the next EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+	 *                                  you can indicate just the columns you want returned
+	 * @return array|EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function next($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->next($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Returns the previous EE_Base_Class object in sequence from this object as found in the database
+	 * matching the given query conditions.
+	 *
+	 * @param null  $field_to_order_by  What field is being used as the reference point.
+	 * @param array $query_params       Any additional conditions on the query.
+	 * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+	 *                                  you can indicate just the column you want returned
+	 * @return array|EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function previous($field_to_order_by = null, $query_params = array(), $columns_to_select = null)
+	{
+		$model         = $this->get_model();
+		$field         = empty($field_to_order_by) && $model->has_primary_key_field()
+			? $model->get_primary_key_field()->get_name()
+			: $field_to_order_by;
+		$current_value = ! empty($field) ? $this->get($field) : null;
+		if (empty($field) || empty($current_value)) {
+			return array();
+		}
+		return $model->previous($current_value, $field, $query_params, $columns_to_select);
+	}
+
+
+	/**
+	 * Overrides parent because parent expects old models.
+	 * This also doesn't do any validation, and won't work for serialized arrays
+	 *
+	 * @param string $field_name
+	 * @param mixed  $field_value_from_db
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function set_from_db($field_name, $field_value_from_db)
+	{
+		$field_obj = $this->get_model()->field_settings_for($field_name);
+		if ($field_obj instanceof EE_Model_Field_Base) {
+			//you would think the DB has no NULLs for non-null label fields right? wrong!
+			//eg, a CPT model object could have an entry in the posts table, but no
+			//entry in the meta table. Meaning that all its columns in the meta table
+			//are null! yikes! so when we find one like that, use defaults for its meta columns
+			if ($field_value_from_db === null) {
+				if ($field_obj->is_nullable()) {
+					//if the field allows nulls, then let it be null
+					$field_value = null;
+				} else {
+					$field_value = $field_obj->get_default_value();
+				}
+			} else {
+				$field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
+			}
+			$this->_fields[ $field_name ] = $field_value;
+			$this->_clear_cached_property($field_name);
+		}
+	}
+
+
+	/**
+	 * verifies that the specified field is of the correct type
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, false, $extra_cache_ref);
+	}
+
+
+	/**
+	 * This method simply returns the RAW unprocessed value for the given property in this class
+	 *
+	 * @param  string $field_name A valid fieldname
+	 * @return mixed              Whatever the raw value stored on the property is.
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error if fieldSettings is misconfigured or the field doesn't exist.
+	 */
+	public function get_raw($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
+			? $this->_fields[ $field_name ]->format('U')
+			: $this->_fields[ $field_name ];
+	}
+
+
+	/**
+	 * This is used to return the internal DateTime object used for a field that is a
+	 * EE_Datetime_Field.
+	 *
+	 * @param string $field_name               The field name retrieving the DateTime object.
+	 * @return mixed null | false | DateTime  If the requested field is NOT a EE_Datetime_Field then
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 *                                         an error is set and false returned.  If the field IS an
+	 *                                         EE_Datetime_Field and but the field value is null, then
+	 *                                         just null is returned (because that indicates that likely
+	 *                                         this field is nullable).
+	 */
+	public function get_DateTime_object($field_name)
+	{
+		$field_settings = $this->get_model()->field_settings_for($field_name);
+		if (! $field_settings instanceof EE_Datetime_Field) {
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'The field %s is not an EE_Datetime_Field field.  There is no DateTime object stored on this field type.',
+						'event_espresso'
+					),
+					$field_name
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return $this->_fields[ $field_name ];
+	}
+
+
+	/**
+	 * To be used in template to immediately echo out the value, and format it for output.
+	 * Eg, should call stripslashes and whatnot before echoing
+	 *
+	 * @param string $field_name      the name of the field as it appears in the DB
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e($field_name, $extra_cache_ref = null)
+	{
+		echo $this->get_pretty($field_name, $extra_cache_ref);
+	}
+
+
+	/**
+	 * Exactly like e(), echoes out the field, but sets its schema to 'form_input', so that it
+	 * can be easily used as the value of form input.
+	 *
+	 * @param string $field_name
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function f($field_name)
+	{
+		$this->e($field_name, 'form_input');
+	}
+
+
+	/**
+	 * Same as `f()` but just returns the value instead of echoing it
+	 *
+	 * @param string $field_name
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_f($field_name)
+	{
+		return (string) $this->get_pretty($field_name, 'form_input');
+	}
+
+
+	/**
+	 * Gets a pretty view of the field's value. $extra_cache_ref can specify different formats for this.
+	 * The $extra_cache_ref will be passed to the model field's prepare_for_pretty_echoing, so consult the field's class
+	 * to see what options are available.
+	 *
+	 * @param string $field_name
+	 * @param string $extra_cache_ref This allows the user to specify an extra cache ref for the given property
+	 *                                (in cases where the same property may be used for different outputs
+	 *                                - i.e. datetime, money etc.)
+	 * @return mixed
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_pretty($field_name, $extra_cache_ref = null)
+	{
+		return $this->_get_cached_property($field_name, true, $extra_cache_ref);
+	}
+
+
+	/**
+	 * This simply returns the datetime for the given field name
+	 * Note: this protected function is called by the wrapper get_date or get_time or get_datetime functions
+	 * (and the equivalent e_date, e_time, e_datetime).
+	 *
+	 * @access   protected
+	 * @param string   $field_name   Field on the instantiated EE_Base_Class child object
+	 * @param string   $dt_frmt      valid datetime format used for date
+	 *                               (if '' then we just use the default on the field,
+	 *                               if NULL we use the last-used format)
+	 * @param string   $tm_frmt      Same as above except this is for time format
+	 * @param string   $date_or_time if NULL then both are returned, otherwise "D" = only date and "T" = only time.
+	 * @param  boolean $echo         Whether the dtt is echoing using pretty echoing or just returned using vanilla get
+	 * @return string|bool|EE_Error string on success, FALSE on fail, or EE_Error Exception is thrown
+	 *                               if field is not a valid dtt field, or void if echoing
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _get_datetime($field_name, $dt_frmt = '', $tm_frmt = '', $date_or_time = '', $echo = false)
+	{
+		// clear cached property
+		$this->_clear_cached_property($field_name);
+		//reset format properties because they are used in get()
+		$this->_dt_frmt = $dt_frmt !== '' ? $dt_frmt : $this->_dt_frmt;
+		$this->_tm_frmt = $tm_frmt !== '' ? $tm_frmt : $this->_tm_frmt;
+		if ($echo) {
+			$this->e($field_name, $date_or_time);
+			return '';
+		}
+		return $this->get($field_name, $date_or_time);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the date
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the date returned (if NULL we use default in dt_frmt property)
+	 * @return string            datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_date($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, $format, null, 'D');
+	}
+
+
+	/**
+	 * @param        $field_name
+	 * @param string $format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_date($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, $format, null, 'D', true);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for JUST returning the time
+	 * portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $format     format for the time returned ( if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_time($field_name, $format = '')
+	{
+		return $this->_get_datetime($field_name, null, $format, 'T');
+	}
+
+
+	/**
+	 * @param        $field_name
+	 * @param string $format
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_time($field_name, $format = '')
+	{
+		$this->_get_datetime($field_name, null, $format, 'T', true);
+	}
+
+
+	/**
+	 * below are wrapper functions for the various datetime outputs that can be obtained for returning the date AND
+	 * time portion of a datetime value. (note the only difference between get_ and e_ is one returns the value and the
+	 * other echoes the pretty value for dtt)
+	 *
+	 * @param  string $field_name name of model object datetime field holding the value
+	 * @param  string $dt_frmt    format for the date returned (if NULL we use default in dt_frmt property)
+	 * @param  string $tm_frmt    format for the time returned (if NULL we use default in tm_frmt property)
+	 * @return string             datetime value formatted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		return $this->_get_datetime($field_name, $dt_frmt, $tm_frmt);
+	}
+
+
+	/**
+	 * @param string $field_name
+	 * @param string $dt_frmt
+	 * @param string $tm_frmt
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function e_datetime($field_name, $dt_frmt = '', $tm_frmt = '')
+	{
+		$this->_get_datetime($field_name, $dt_frmt, $tm_frmt, null, true);
+	}
+
+
+	/**
+	 * Get the i8ln value for a date using the WordPress @see date_i18n function.
+	 *
+	 * @param string $field_name The EE_Datetime_Field reference for the date being retrieved.
+	 * @param string $format     PHP valid date/time string format.  If none is provided then the internal set format
+	 *                           on the object will be used.
+	 * @return string Date and time string in set locale or false if no field exists for the given
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 *                           field name.
+	 */
+	public function get_i18n_datetime($field_name, $format = '')
+	{
+		$format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+		return date_i18n(
+			$format,
+			EEH_DTT_Helper::get_timestamp_with_offset(
+				$this->get_raw($field_name),
+				$this->_timezone
+			)
+		);
+	}
+
+
+	/**
+	 * This method validates whether the given field name is a valid field on the model object as well as it is of a
+	 * type EE_Datetime_Field.  On success there will be returned the field settings.  On fail an EE_Error exception is
+	 * thrown.
+	 *
+	 * @param  string $field_name The field name being checked
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return EE_Datetime_Field
+	 */
+	protected function _get_dtt_field_settings($field_name)
+	{
+		$field = $this->get_model()->field_settings_for($field_name);
+		//check if field is dtt
+		if ($field instanceof EE_Datetime_Field) {
+			return $field;
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__(
+					'The field name "%s" has been requested for the EE_Base_Class datetime functions and it is not a valid EE_Datetime_Field.  Please check the spelling of the field and make sure it has been setup as a EE_Datetime_Field in the %s model constructor',
+					'event_espresso'
+				),
+				$field_name,
+				self::_get_model_classname(get_class($this))
+			)
+		);
+	}
+
+
+
+
+	/**
+	 * NOTE ABOUT BELOW:
+	 * These convenience date and time setters are for setting date and time independently.  In other words you might
+	 * want to change the time on a datetime_field but leave the date the same (or vice versa). IF on the other hand
+	 * you want to set both date and time at the same time, you can just use the models default set($fieldname,$value)
+	 * method and make sure you send the entire datetime value for setting.
+	 */
+	/**
+	 * sets the time on a datetime property
+	 *
+	 * @access protected
+	 * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+	 * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_time_for($time, $fieldname)
+	{
+		$this->_set_date_time('T', $time, $fieldname);
+	}
+
+
+	/**
+	 * sets the date on a datetime property
+	 *
+	 * @access protected
+	 * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+	 * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_date_for($date, $fieldname)
+	{
+		$this->_set_date_time('D', $date, $fieldname);
+	}
+
+
+	/**
+	 * This takes care of setting a date or time independently on a given model object property. This method also
+	 * verifies that the given fieldname matches a model object property and is for a EE_Datetime_Field field
+	 *
+	 * @access protected
+	 * @param string          $what           "T" for time, 'B' for both, 'D' for Date.
+	 * @param string|DateTime $datetime_value A valid Date or Time string (or DateTime object)
+	 * @param string          $fieldname      the name of the field the date OR time is being set on (must match a
+	 *                                        EE_Datetime_Field property)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _set_date_time($what = 'T', $datetime_value, $fieldname)
+	{
+		$field = $this->_get_dtt_field_settings($fieldname);
+		$field->set_timezone($this->_timezone);
+		$field->set_date_format($this->_dt_frmt);
+		$field->set_time_format($this->_tm_frmt);
+		switch ($what) {
+			case 'T' :
+				$this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_time(
+					$datetime_value,
+					$this->_fields[ $fieldname ]
+				);
+				break;
+			case 'D' :
+				$this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_date(
+					$datetime_value,
+					$this->_fields[ $fieldname ]
+				);
+				break;
+			case 'B' :
+				$this->_fields[ $fieldname ] = $field->prepare_for_set($datetime_value);
+				break;
+		}
+		$this->_clear_cached_property($fieldname);
+	}
+
+
+	/**
+	 * This will return a timestamp for the website timezone but ONLY when the current website timezone is different
+	 * than the timezone set for the website. NOTE, this currently only works well with methods that return values.  If
+	 * you use it with methods that echo values the $_timestamp property may not get reset to its original value and
+	 * that could lead to some unexpected results!
+	 *
+	 * @access public
+	 * @param string $field_name               This is the name of the field on the object that contains the date/time
+	 *                                         value being returned.
+	 * @param string $callback                 must match a valid method in this class (defaults to get_datetime)
+	 * @param mixed (array|string) $args       This is the arguments that will be passed to the callback.
+	 * @param string $prepend                  You can include something to prepend on the timestamp
+	 * @param string $append                   You can include something to append on the timestamp
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return string timestamp
+	 */
+	public function display_in_my_timezone(
+		$field_name,
+		$callback = 'get_datetime',
+		$args = null,
+		$prepend = '',
+		$append = ''
+	) {
+		$timezone = EEH_DTT_Helper::get_timezone();
+		if ($timezone === $this->_timezone) {
+			return '';
+		}
+		$original_timezone = $this->_timezone;
+		$this->set_timezone($timezone);
+		$fn   = (array) $field_name;
+		$args = array_merge($fn, (array) $args);
+		if (! method_exists($this, $callback)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'The method named "%s" given as the callback param in "display_in_my_timezone" does not exist.  Please check your spelling',
+						'event_espresso'
+					),
+					$callback
+				)
+			);
+		}
+		$args   = (array) $args;
+		$return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+		$this->set_timezone($original_timezone);
+		return $return;
+	}
+
+
+	/**
+	 * Deletes this model object.
+	 * This calls the `EE_Base_Class::_delete` method.  Child classes wishing to change default behaviour should
+	 * override
+	 * `EE_Base_Class::_delete` NOT this class.
+	 *
+	 * @return boolean | int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete()
+	{
+		/**
+		 * Called just before the `EE_Base_Class::_delete` method call.
+		 * Note:
+		 * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.
+		 * For example, `EE_Soft_Delete_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete__before', $this);
+		$result = $this->_delete();
+		/**
+		 * Called just after the `EE_Base_Class::_delete` method call.
+		 * Note:
+		 * `EE_Base_Class::_delete` might be overridden by child classes so any client code hooking into these actions
+		 * should be aware that `_delete` may not always result in a permanent delete.
+		 * For example `EE_Soft_Base_Class::_delete`
+		 * soft deletes (trash) the object and does not permanently delete it.
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete__end', $this, $result);
+		return $result;
+	}
+
+
+	/**
+	 * Calls the specific delete method for the instantiated class.
+	 * This method is called by the public `EE_Base_Class::delete` method.  Any child classes desiring to override
+	 * default functionality for "delete" (which is to call `permanently_delete`) should override this method NOT
+	 * `EE_Base_Class::delete`
+	 *
+	 * @return bool|int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _delete()
+	{
+		return $this->delete_permanently();
+	}
+
+
+	/**
+	 * Deletes this model object permanently from db
+	 * (but keep in mind related models may block the delete and return an error)
+	 *
+	 * @return bool | int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_permanently()
+	{
+		/**
+		 * Called just before HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object about to be 'deleted'
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__before', $this);
+		$model  = $this->get_model();
+		$result = $model->delete_permanently_by_ID($this->ID());
+		$this->refresh_cache_of_related_objects();
+		/**
+		 * Called just after HARD deleting a model object
+		 *
+		 * @param EE_Base_Class $model_object that was just 'deleted'
+		 * @param boolean       $result
+		 */
+		do_action('AHEE__EE_Base_Class__delete_permanently__end', $this, $result);
+		return $result;
+	}
+
+
+	/**
+	 * When this model object is deleted, it may still be cached on related model objects. This clears the cache of
+	 * related model objects
+	 *
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function refresh_cache_of_related_objects()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if (! empty($this->_model_relations[ $relation_name ])) {
+				$related_objects = $this->_model_relations[ $relation_name ];
+				if ($relation_obj instanceof EE_Belongs_To_Relation) {
+					//this relation only stores a single model object, not an array
+					//but let's make it consistent
+					$related_objects = array($related_objects);
+				}
+				foreach ($related_objects as $related_object) {
+					//only refresh their cache if they're in memory
+					if ($related_object instanceof EE_Base_Class) {
+						$related_object->clear_cache(
+							$model->get_this_model_name(),
+							$this
+						);
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 *        Saves this object to the database. An array may be supplied to set some values on this
+	 * object just before saving.
+	 *
+	 * @access public
+	 * @param array $set_cols_n_values keys are field names, values are their new values,
+	 *                                 if provided during the save() method (often client code will change the fields'
+	 *                                 values before calling save)
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return int , 1 on a successful update, the ID of the new entry on insert; 0 on failure or if the model object
+	 *                                 isn't allowed to persist (as determined by EE_Base_Class::allow_persist())
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function save($set_cols_n_values = array())
+	{
+		$model = $this->get_model();
+		/**
+		 * Filters the fields we're about to save on the model object
+		 *
+		 * @param array         $set_cols_n_values
+		 * @param EE_Base_Class $model_object
+		 */
+		$set_cols_n_values = (array) apply_filters(
+			'FHEE__EE_Base_Class__save__set_cols_n_values',
+			$set_cols_n_values,
+			$this
+		);
+		//set attributes as provided in $set_cols_n_values
+		foreach ($set_cols_n_values as $column => $value) {
+			$this->set($column, $value);
+		}
+		// no changes ? then don't do anything
+		if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+			return 0;
+		}
+		/**
+		 * Saving a model object.
+		 * Before we perform a save, this action is fired.
+		 *
+		 * @param EE_Base_Class $model_object the model object about to be saved.
+		 */
+		do_action('AHEE__EE_Base_Class__save__begin', $this);
+		if (! $this->allow_persist()) {
+			return 0;
+		}
+		// now get current attribute values
+		$save_cols_n_values = $this->_fields;
+		// if the object already has an ID, update it. Otherwise, insert it
+		// also: change the assumption about values passed to the model NOT being prepare dby the model object.
+		// They have been
+		$old_assumption_concerning_value_preparation = $model
+			->get_assumption_concerning_values_already_prepared_by_model_object();
+		$model->assume_values_already_prepared_by_model_object(true);
+		//does this model have an autoincrement PK?
+		if ($model->has_primary_key_field()) {
+			if ($model->get_primary_key_field()->is_auto_increment()) {
+				//ok check if it's set, if so: update; if not, insert
+				if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					unset($save_cols_n_values[ $model->primary_key_name() ]);
+					$results = $model->insert($save_cols_n_values);
+					if ($results) {
+						//if successful, set the primary key
+						//but don't use the normal SET method, because it will check if
+						//an item with the same ID exists in the mapper & db, then
+						//will find it in the db (because we just added it) and THAT object
+						//will get added to the mapper before we can add this one!
+						//but if we just avoid using the SET method, all that headache can be avoided
+						$pk_field_name                   = $model->primary_key_name();
+						$this->_fields[ $pk_field_name ] = $results;
+						$this->_clear_cached_property($pk_field_name);
+						$model->add_to_entity_map($this);
+						$this->_update_cached_related_model_objs_fks();
+					}
+				}
+			} else {//PK is NOT auto-increment
+				//so check if one like it already exists in the db
+				if ($model->exists_by_ID($this->ID())) {
+					if (WP_DEBUG && ! $this->in_entity_map()) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'Using a model object %1$s that is NOT in the entity map, can lead to unexpected errors. You should either: %4$s 1. Put it in the entity mapper by calling %2$s %4$s 2. Discard this model object and use what is in the entity mapper %4$s 3. Fetch from the database using %3$s',
+									'event_espresso'
+								),
+								get_class($this),
+								get_class($model) . '::instance()->add_to_entity_map()',
+								get_class($model) . '::instance()->get_one_by_ID()',
+								'<br />'
+							)
+						);
+					}
+					$results = $model->update_by_ID($save_cols_n_values, $this->ID());
+				} else {
+					$results = $model->insert($save_cols_n_values);
+					$this->_update_cached_related_model_objs_fks();
+				}
+			}
+		} else {//there is NO primary key
+			$already_in_db = false;
+			foreach ($model->unique_indexes() as $index) {
+				$uniqueness_where_params = array_intersect_key($save_cols_n_values, $index->fields());
+				if ($model->exists(array($uniqueness_where_params))) {
+					$already_in_db = true;
+				}
+			}
+			if ($already_in_db) {
+				$combined_pk_fields_n_values = array_intersect_key($save_cols_n_values,
+					$model->get_combined_primary_key_fields());
+				$results                     = $model->update(
+					$save_cols_n_values,
+					$combined_pk_fields_n_values
+				);
+			} else {
+				$results = $model->insert($save_cols_n_values);
+			}
+		}
+		//restore the old assumption about values being prepared by the model object
+		$model->assume_values_already_prepared_by_model_object(
+				$old_assumption_concerning_value_preparation
+			);
+		/**
+		 * After saving the model object this action is called
+		 *
+		 * @param EE_Base_Class $model_object which was just saved
+		 * @param boolean|int   $results      if it were updated, TRUE or FALSE; if it were newly inserted
+		 *                                    the new ID (or 0 if an error occurred and it wasn't updated)
+		 */
+		do_action('AHEE__EE_Base_Class__save__end', $this, $results);
+		$this->_has_changes = false;
+		return $results;
+	}
+
+
+	/**
+	 * Updates the foreign key on related models objects pointing to this to have this model object's ID
+	 * as their foreign key.  If the cached related model objects already exist in the db, saves them (so that the DB
+	 * is consistent) Especially useful in case we JUST added this model object ot the database and we want to let its
+	 * cached relations with foreign keys to it know about that change. Eg: we've created a transaction but haven't
+	 * saved it to the db. We also create a registration and don't save it to the DB, but we DO cache it on the
+	 * transaction. Now, when we save the transaction, the registration's TXN_ID will be automatically updated, whether
+	 * or not they exist in the DB (if they do, their DB records will be automatically updated)
+	 *
+	 * @return void
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected function _update_cached_related_model_objs_fks()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Has_Many_Relation) {
+				foreach ($this->get_all_from_cache($relation_name) as $related_model_obj_in_cache) {
+					$fk_to_this = $related_model_obj_in_cache->get_model()->get_foreign_key_to(
+						$model->get_this_model_name()
+					);
+					$related_model_obj_in_cache->set($fk_to_this->get_name(), $this->ID());
+					if ($related_model_obj_in_cache->ID()) {
+						$related_model_obj_in_cache->save();
+					}
+				}
+			}
+		}
+	}
+
+
+	/**
+	 * Saves this model object and its NEW cached relations to the database.
+	 * (Meaning, for now, IT DOES NOT WORK if the cached items already exist in the DB.
+	 * In order for that to work, we would need to mark model objects as dirty/clean...
+	 * because otherwise, there's a potential for infinite looping of saving
+	 * Saves the cached related model objects, and ensures the relation between them
+	 * and this object and properly setup
+	 *
+	 * @return int ID of new model object on save; 0 on failure+
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function save_new_cached_related_model_objs()
+	{
+		//make sure this has been saved
+		if (! $this->ID()) {
+			$id = $this->save();
+		} else {
+			$id = $this->ID();
+		}
+		//now save all the NEW cached model objects  (ie they don't exist in the DB)
+		foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
+			if ($this->_model_relations[ $relationName ]) {
+				//is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
+				//or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
+				/* @var $related_model_obj EE_Base_Class */
+				if ($relationObj instanceof EE_Belongs_To_Relation) {
+					//add a relation to that relation type (which saves the appropriate thing in the process)
+					//but ONLY if it DOES NOT exist in the DB
+					$related_model_obj = $this->_model_relations[ $relationName ];
+					//					if( ! $related_model_obj->ID()){
+					$this->_add_relation_to($related_model_obj, $relationName);
+					$related_model_obj->save_new_cached_related_model_objs();
+					//					}
+				} else {
+					foreach ($this->_model_relations[ $relationName ] as $related_model_obj) {
+						//add a relation to that relation type (which saves the appropriate thing in the process)
+						//but ONLY if it DOES NOT exist in the DB
+						//						if( ! $related_model_obj->ID()){
+						$this->_add_relation_to($related_model_obj, $relationName);
+						$related_model_obj->save_new_cached_related_model_objs();
+						//						}
+					}
+				}
+			}
+		}
+		return $id;
+	}
+
+
+	/**
+	 * for getting a model while instantiated.
+	 *
+	 * @return EEM_Base | EEM_CPT_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_model()
+	{
+		if (! $this->_model) {
+			$modelName    = self::_get_model_classname(get_class($this));
+			$this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
+		} else {
+			$this->_model->set_timezone($this->_timezone);
+		}
+		return $this->_model;
+	}
+
+
+	/**
+	 * @param $props_n_values
+	 * @param $classname
+	 * @return mixed bool|EE_Base_Class|EEM_CPT_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected static function _get_object_from_entity_mapper($props_n_values, $classname)
+	{
+		//TODO: will not work for Term_Relationships because they have no PK!
+		$primary_id_ref = self::_get_primary_key_name($classname);
+		if (
+			array_key_exists($primary_id_ref, $props_n_values)
+			&& ! empty($props_n_values[ $primary_id_ref ])
+		) {
+			$id = $props_n_values[ $primary_id_ref ];
+			return self::_get_model($classname)->get_from_entity_map($id);
+		}
+		return false;
+	}
+
+
+	/**
+	 * This is called by child static "new_instance" method and we'll check to see if there is an existing db entry for
+	 * the primary key (if present in incoming values). If there is a key in the incoming array that matches the
+	 * primary key for the model AND it is not null, then we check the db. If there's a an object we return it.  If not
+	 * we return false.
+	 *
+	 * @param  array  $props_n_values   incoming array of properties and their values
+	 * @param  string $classname        the classname of the child class
+	 * @param null    $timezone
+	 * @param array   $date_formats     incoming date_formats in an array where the first value is the
+	 *                                  date_format and the second value is the time format
+	 * @return mixed (EE_Base_Class|bool)
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	protected static function _check_for_object($props_n_values, $classname, $timezone = null, $date_formats = array())
+	{
+		$existing = null;
+		$model    = self::_get_model($classname, $timezone);
+		if ($model->has_primary_key_field()) {
+			$primary_id_ref = self::_get_primary_key_name($classname);
+			if (array_key_exists($primary_id_ref, $props_n_values)
+				&& ! empty($props_n_values[ $primary_id_ref ])
+			) {
+				$existing = $model->get_one_by_ID(
+					$props_n_values[ $primary_id_ref ]
+				);
+			}
+		} elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
+			//no primary key on this model, but there's still a matching item in the DB
+			$existing = self::_get_model($classname, $timezone)->get_one_by_ID(
+				self::_get_model($classname, $timezone)
+					->get_index_primary_key_string($props_n_values)
+			);
+		}
+		if ($existing) {
+			//set date formats if present before setting values
+			if (! empty($date_formats) && is_array($date_formats)) {
+				$existing->set_date_format($date_formats[0]);
+				$existing->set_time_format($date_formats[1]);
+			} else {
+				//set default formats for date and time
+				$existing->set_date_format(get_option('date_format'));
+				$existing->set_time_format(get_option('time_format'));
+			}
+			foreach ($props_n_values as $property => $field_value) {
+				$existing->set($property, $field_value);
+			}
+			return $existing;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the EEM_*_Model for this class
+	 *
+	 * @access public now, as this is more convenient
+	 * @param      $classname
+	 * @param null $timezone
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return EEM_Base
+	 */
+	protected static function _get_model($classname, $timezone = null)
+	{
+		//find model for this class
+		if (! $classname) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'What were you thinking calling _get_model(%s)?? You need to specify the class name',
+						'event_espresso'
+					),
+					$classname
+				)
+			);
+		}
+		$modelName = self::_get_model_classname($classname);
+		return self::_get_model_instance_with_name($modelName, $timezone);
+	}
+
+
+	/**
+	 * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
+	 *
+	 * @param string $model_classname
+	 * @param null   $timezone
+	 * @return EEM_Base
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	protected static function _get_model_instance_with_name($model_classname, $timezone = null)
+	{
+		$model_classname = str_replace('EEM_', '', $model_classname);
+		$model           = EE_Registry::instance()->load_model($model_classname);
+		$model->set_timezone($timezone);
+		return $model;
+	}
+
+
+	/**
+	 * If a model name is provided (eg Registration), gets the model classname for that model.
+	 * Also works if a model class's classname is provided (eg EE_Registration).
+	 *
+	 * @param null $model_name
+	 * @return string like EEM_Attendee
+	 */
+	private static function _get_model_classname($model_name = null)
+	{
+		if (strpos($model_name, 'EE_') === 0) {
+			$model_classname = str_replace('EE_', 'EEM_', $model_name);
+		} else {
+			$model_classname = 'EEM_' . $model_name;
+		}
+		return $model_classname;
+	}
+
+
+	/**
+	 * returns the name of the primary key attribute
+	 *
+	 * @param null $classname
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return string
+	 */
+	protected static function _get_primary_key_name($classname = null)
+	{
+		if (! $classname) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
+					$classname
+				)
+			);
+		}
+		return self::_get_model($classname)->get_primary_key_field()->get_name();
+	}
+
+
+	/**
+	 * Gets the value of the primary key.
+	 * If the object hasn't yet been saved, it should be whatever the model field's default was
+	 * (eg, if this were the EE_Event class, look at the primary key field on EEM_Event and see what its default value
+	 * is. Usually defaults for integer primary keys are 0; string primary keys are usually NULL).
+	 *
+	 * @return mixed, if the primary key is of type INT it'll be an int. Otherwise it could be a string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function ID()
+	{
+		$model = $this->get_model();
+		//now that we know the name of the variable, use a variable variable to get its value and return its
+		if ($model->has_primary_key_field()) {
+			return $this->_fields[ $model->primary_key_name() ];
+		}
+		return $model->get_index_primary_key_string($this->_fields);
+	}
+
+
+	/**
+	 * Adds a relationship to the specified EE_Base_Class object, given the relationship's name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Event', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just caches the related thing
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID       EE_Base_Class or the ID of the other object
+	 * @param string $relationName                     eg 'Events','Question',etc.
+	 *                                                 an attendee to a group, you also want to specify which role they
+	 *                                                 will have in that group. So you would use this parameter to
+	 *                                                 specify array('role-column-name'=>'role-id')
+	 * @param array  $extra_join_model_fields_n_values You can optionally include an array of key=>value pairs that
+	 *                                                 allow you to further constrict the relation to being added.
+	 *                                                 However, keep in mind that the columns (keys) given must match a
+	 *                                                 column on the JOIN table and currently only the HABTM models
+	 *                                                 accept these additional conditions.  Also remember that if an
+	 *                                                 exact match isn't found for these extra cols/val pairs, then a
+	 *                                                 NEW row is created in the join table.
+	 * @param null   $cache_id
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @return EE_Base_Class the object the relation was added to
+	 */
+	public function _add_relation_to(
+		$otherObjectModelObjectOrID,
+		$relationName,
+		$extra_join_model_fields_n_values = array(),
+		$cache_id = null
+	) {
+		$model = $this->get_model();
+		//if this thing exists in the DB, save the relation to the DB
+		if ($this->ID()) {
+			$otherObject = $model->add_relationship_to(
+				$this,
+				$otherObjectModelObjectOrID,
+				$relationName,
+				$extra_join_model_fields_n_values
+			);
+			//clear cache so future get_many_related and get_first_related() return new results.
+			$this->clear_cache($relationName, $otherObject, true);
+			if ($otherObject instanceof EE_Base_Class) {
+				$otherObject->clear_cache($model->get_this_model_name(), $this);
+			}
+		} else {
+			//this thing doesn't exist in the DB,  so just cache it
+			if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Before a model object is saved to the database, calls to _add_relation_to must be passed an actual object, not just an ID. You provided %s as the model object to a %s',
+							'event_espresso'
+						),
+						$otherObjectModelObjectOrID,
+						get_class($this)
+					)
+				);
+			}
+			$otherObject = $otherObjectModelObjectOrID;
+			$this->cache($relationName, $otherObjectModelObjectOrID, $cache_id);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			//fix the reciprocal relation too
+			if ($otherObject->ID()) {
+				//its saved so assumed relations exist in the DB, so we can just
+				//clear the cache so future queries use the updated info in the DB
+				$otherObject->clear_cache(
+					$model->get_this_model_name(),
+					null,
+					true
+				);
+			} else {
+				//it's not saved, so it caches relations like this
+				$otherObject->cache($model->get_this_model_name(), $this);
+			}
+		}
+		return $otherObject;
+	}
+
+
+	/**
+	 * Removes a relationship to the specified EE_Base_Class object, given the relationships' name. Eg, if the current
+	 * model is related to a group of events, the $relationName should be 'Events', and should be a key in the EE
+	 * Model's $_model_relations array. If this model object doesn't exist in the DB, just removes the related thing
+	 * from the cache
+	 *
+	 * @param mixed  $otherObjectModelObjectOrID
+	 *                EE_Base_Class or the ID of the other object, OR an array key into the cache if this isn't saved
+	 *                to the DB yet
+	 * @param string $relationName
+	 * @param array  $where_query
+	 *                You can optionally include an array of key=>value pairs that allow you to further constrict the
+	 *                relation to being added. However, keep in mind that the columns (keys) given must match a column
+	 *                on the JOIN table and currently only the HABTM models accept these additional conditions. Also
+	 *                remember that if an exact match isn't found for these extra cols/val pairs, then a NEW row is
+	 *                created in the join table.
+	 * @return EE_Base_Class the relation was removed from
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function _remove_relation_to($otherObjectModelObjectOrID, $relationName, $where_query = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObject = $this->get_model()->remove_relationship_to(
+				$this,
+				$otherObjectModelObjectOrID,
+				$relationName,
+				$where_query
+			);
+			$this->clear_cache(
+				$relationName,
+				$otherObject
+			);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObject = $this->clear_cache(
+				$relationName,
+				$otherObjectModelObjectOrID
+			);
+		}
+		if ($otherObject instanceof EE_Base_Class) {
+			$otherObject->clear_cache(
+				$this->get_model()->get_this_model_name(),
+				$this
+			);
+		}
+		return $otherObject;
+	}
+
+
+	/**
+	 * Removes ALL the related things for the $relationName.
+	 *
+	 * @param string $relationName
+	 * @param array  $where_query_params like EEM_Base::get_all's $query_params[0] (where conditions)
+	 * @return EE_Base_Class
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function _remove_relations($relationName, $where_query_params = array())
+	{
+		if ($this->ID()) {
+			//if this exists in the DB, save the relation change to the DB too
+			$otherObjects = $this->get_model()->remove_relations(
+				$this,
+				$relationName,
+				$where_query_params
+			);
+			$this->clear_cache(
+				$relationName,
+				null,
+				true
+			);
+		} else {
+			//this doesn't exist in the DB, just remove it from the cache
+			$otherObjects = $this->clear_cache(
+				$relationName,
+				null,
+				true
+			);
+		}
+		if (is_array($otherObjects)) {
+			foreach ($otherObjects as $otherObject) {
+				$otherObject->clear_cache(
+					$this->get_model()->get_this_model_name(),
+					$this
+				);
+			}
+		}
+		return $otherObjects;
+	}
+
+
+	/**
+	 * Gets all the related model objects of the specified type. Eg, if the current class if
+	 * EE_Event, you could call $this->get_many_related('Registration') to get an array of all the
+	 * EE_Registration objects which related to this event. Note: by default, we remove the "default query params"
+	 * because we want to get even deleted items etc.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class[]     Results not necessarily indexed by IDs, because some results might not have primary
+	 *                             keys or might not be saved yet. Consider using EEM_Base::get_IDs() on these
+	 *                             results if you want IDs
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_many_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			//this exists in the DB, so get the related things from either the cache or the DB
+			//if there are query parameters, forget about caching the related model objects.
+			if ($query_params) {
+				$related_model_objects = $this->get_model()->get_all_related(
+					$this,
+					$relationName,
+					$query_params
+				);
+			} else {
+				//did we already cache the result of this query?
+				$cached_results = $this->get_all_from_cache($relationName);
+				if (! $cached_results) {
+					$related_model_objects = $this->get_model()->get_all_related(
+						$this,
+						$relationName,
+						$query_params
+					);
+					//if no query parameters were passed, then we got all the related model objects
+					//for that relation. We can cache them then.
+					foreach ($related_model_objects as $related_model_object) {
+						$this->cache($relationName, $related_model_object);
+					}
+				} else {
+					$related_model_objects = $cached_results;
+				}
+			}
+		} else {
+			//this doesn't exist in the DB, so just get the related things from the cache
+			$related_model_objects = $this->get_all_from_cache($relationName);
+		}
+		return $related_model_objects;
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply counts them. Ignores default_where_conditions by default,
+	 * unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name  model_name like 'Event', or 'Registration'
+	 * @param array  $query_params   like EEM_Base::get_all's
+	 * @param string $field_to_count name of field to count by. By default, uses primary key
+	 * @param bool   $distinct       if we want to only count the distinct values for the column then you can trigger
+	 *                               that by the setting $distinct to TRUE;
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function count_related($relation_name, $query_params = array(), $field_to_count = null, $distinct = false)
+	{
+		return $this->get_model()->count_related(
+			$this,
+			$relation_name,
+			$query_params,
+			$field_to_count,
+			$distinct
+		);
+	}
+
+
+	/**
+	 * Instead of getting the related model objects, simply sums up the values of the specified field.
+	 * Note: ignores default_where_conditions by default, unless otherwise specified in the $query_params
+	 *
+	 * @param string $relation_name model_name like 'Event', or 'Registration'
+	 * @param array  $query_params  like EEM_Base::get_all's
+	 * @param string $field_to_sum  name of field to count by.
+	 *                              By default, uses primary key
+	 *                              (which doesn't make much sense, so you should probably change it)
+	 * @return int
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function sum_related($relation_name, $query_params = array(), $field_to_sum = null)
+	{
+		return $this->get_model()->sum_related(
+			$this,
+			$relation_name,
+			$query_params,
+			$field_to_sum
+		);
+	}
+
+
+	/**
+	 * Gets the first (ie, one) related model object of the specified type.
+	 *
+	 * @param string $relationName key in the model's _model_relations array
+	 * @param array  $query_params like EEM_Base::get_all
+	 * @return EE_Base_Class (not an array, a single object)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_first_related($relationName, $query_params = array())
+	{
+		$model = $this->get_model();
+		if ($this->ID()) {//this exists in the DB, get from the cache OR the DB
+			//if they've provided some query parameters, don't bother trying to cache the result
+			//also make sure we're not caching the result of get_first_related
+			//on a relation which should have an array of objects (because the cache might have an array of objects)
+			if ($query_params
+				|| ! $model->related_settings_for($relationName)
+					 instanceof
+					 EE_Belongs_To_Relation
+			) {
+				$related_model_object = $model->get_first_related(
+					$this,
+					$relationName,
+					$query_params
+				);
+			} else {
+				//first, check if we've already cached the result of this query
+				$cached_result = $this->get_one_from_cache($relationName);
+				if (! $cached_result) {
+					$related_model_object = $model->get_first_related(
+						$this,
+						$relationName,
+						$query_params
+					);
+					$this->cache($relationName, $related_model_object);
+				} else {
+					$related_model_object = $cached_result;
+				}
+			}
+		} else {
+			$related_model_object = null;
+			// this doesn't exist in the Db,
+			// but maybe the relation is of type belongs to, and so the related thing might
+			if ($model->related_settings_for($relationName) instanceof EE_Belongs_To_Relation) {
+				$related_model_object = $model->get_first_related(
+					$this,
+					$relationName,
+					$query_params
+				);
+			}
+			// this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
+			// just get what's cached on this object
+			if (! $related_model_object) {
+				$related_model_object = $this->get_one_from_cache($relationName);
+			}
+		}
+		return $related_model_object;
+	}
+
+
+	/**
+	 * Does a delete on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) does nothing. If the related model objects are
+	 * soft-deletable, they will be soft-deleted regardless of related blocking model objects.
+	 * If this model object doesn't exist yet in the DB, just removes its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_related($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related(
+				$this,
+				$relationName,
+				$query_params
+			);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+			$this->clear_cache($relationName, null, true);
+		}
+		return $count;
+	}
+
+
+	/**
+	 * Does a hard delete (ie, removes the DB row) on all related objects of type $relationName and removes
+	 * the current model object's relation to them. If they can't be deleted (because
+	 * of blocking related model objects) just does a soft delete on it instead, if possible.
+	 * If the related thing isn't a soft-deletable model object, this function is identical
+	 * to delete_related(). If this model object doesn't exist in the DB, just remove its related things
+	 *
+	 * @param string $relationName
+	 * @param array  $query_params like EEM_Base::get_all's
+	 * @return int how many deleted (including those soft deleted)
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function delete_related_permanently($relationName, $query_params = array())
+	{
+		if ($this->ID()) {
+			$count = $this->get_model()->delete_related_permanently(
+				$this,
+				$relationName,
+				$query_params
+			);
+		} else {
+			$count = count($this->get_all_from_cache($relationName));
+		}
+		$this->clear_cache($relationName, null, true);
+		return $count;
+	}
+
+
+	/**
+	 * is_set
+	 * Just a simple utility function children can use for checking if property exists
+	 *
+	 * @access  public
+	 * @param  string $field_name property to check
+	 * @return bool                              TRUE if existing,FALSE if not.
+	 */
+	public function is_set($field_name)
+	{
+		return isset($this->_fields[ $field_name ]);
+	}
+
+
+	/**
+	 * Just a simple utility function children can use for checking if property (or properties) exists and throwing an
+	 * EE_Error exception if they don't
+	 *
+	 * @param  mixed (string|array) $properties properties to check
+	 * @throws EE_Error
+	 * @return bool                              TRUE if existing, throw EE_Error if not.
+	 */
+	protected function _property_exists($properties)
+	{
+		foreach ((array) $properties as $property_name) {
+			//first make sure this property exists
+			if (! $this->_fields[ $property_name ]) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'Trying to retrieve a non-existent property (%s).  Double check the spelling please',
+							'event_espresso'
+						),
+						$property_name
+					)
+				);
+			}
+		}
+		return true;
+	}
+
+
+	/**
+	 * This simply returns an array of model fields for this object
+	 *
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function model_field_array()
+	{
+		$fields     = $this->get_model()->field_settings(false);
+		$properties = array();
+		//remove prepended underscore
+		foreach ($fields as $field_name => $settings) {
+			$properties[ $field_name ] = $this->get($field_name);
+		}
+		return $properties;
+	}
+
+
+	/**
+	 * Very handy general function to allow for plugins to extend any child of EE_Base_Class.
+	 * If a method is called on a child of EE_Base_Class that doesn't exist, this function is called
+	 * (http://www.garfieldtech.com/blog/php-magic-call) and passed the method's name and arguments.
+	 * Instead of requiring a plugin to extend the EE_Base_Class
+	 * (which works fine is there's only 1 plugin, but when will that happen?)
+	 * they can add a hook onto 'filters_hook_espresso__{className}__{methodName}'
+	 * (eg, filters_hook_espresso__EE_Answer__my_great_function)
+	 * and accepts 2 arguments: the object on which the function was called,
+	 * and an array of the original arguments passed to the function.
+	 * Whatever their callback function returns will be returned by this function.
+	 * Example: in functions.php (or in a plugin):
+	 *      add_filter('FHEE__EE_Answer__my_callback','my_callback',10,3);
+	 *      function my_callback($previousReturnValue,EE_Base_Class $object,$argsArray){
+	 *          $returnString= "you called my_callback! and passed args:".implode(",",$argsArray);
+	 *          return $previousReturnValue.$returnString;
+	 *      }
+	 * require('EE_Answer.class.php');
+	 * $answer= EE_Answer::new_instance(array('REG_ID' => 2,'QST_ID' => 3,'ANS_value' => The answer is 42'));
+	 * echo $answer->my_callback('monkeys',100);
+	 * //will output "you called my_callback! and passed args:monkeys,100"
+	 *
+	 * @param string $methodName name of method which was called on a child of EE_Base_Class, but which
+	 * @param array  $args       array of original arguments passed to the function
+	 * @throws EE_Error
+	 * @return mixed whatever the plugin which calls add_filter decides
+	 */
+	public function __call($methodName, $args)
+	{
+		$className = get_class($this);
+		$tagName   = "FHEE__{$className}__{$methodName}";
+		if (! has_filter($tagName)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Method %s on class %s does not exist! You can create one with the following code in functions.php or in a plugin: add_filter('%s','my_callback',10,3);function my_callback(\$previousReturnValue,EE_Base_Class \$object, \$argsArray){/*function body*/return \$whatever;}",
+						'event_espresso'
+					),
+					$methodName,
+					$className,
+					$tagName
+				)
+			);
+		}
+		return apply_filters($tagName, null, $this, $args);
+	}
+
+
+	/**
+	 * Similar to insert_post_meta, adds a record in the Extra_Meta model's table with the given key and value.
+	 * A $previous_value can be specified in case there are many meta rows with the same key
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @param mixed  $previous_value
+	 * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
+	 *                  NOTE: if the values haven't changed, returns 0
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_extra_meta($meta_key, $meta_value, $previous_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($previous_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		$existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
+		if (! $existing_rows_like_that) {
+			return $this->add_extra_meta($meta_key, $meta_value);
+		}
+		foreach ($existing_rows_like_that as $existing_row) {
+			$existing_row->save(array('EXM_value' => $meta_value));
+		}
+		return count($existing_rows_like_that);
+	}
+
+
+	/**
+	 * Adds a new extra meta record. If $unique is set to TRUE, we'll first double-check
+	 * no other extra meta for this model object have the same key. Returns TRUE if the
+	 * extra meta row was entered, false if not
+	 *
+	 * @param string  $meta_key
+	 * @param mixed   $meta_value
+	 * @param boolean $unique
+	 * @return boolean
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws ReflectionException
+	 */
+	public function add_extra_meta($meta_key, $meta_value, $unique = false)
+	{
+		if ($unique) {
+			$existing_extra_meta = EEM_Extra_Meta::instance()->get_one(
+				array(
+					array(
+						'EXM_key'  => $meta_key,
+						'OBJ_ID'   => $this->ID(),
+						'EXM_type' => $this->get_model()->get_this_model_name(),
+					),
+				)
+			);
+			if ($existing_extra_meta) {
+				return false;
+			}
+		}
+		$new_extra_meta = EE_Extra_Meta::new_instance(
+			array(
+				'EXM_key'   => $meta_key,
+				'EXM_value' => $meta_value,
+				'OBJ_ID'    => $this->ID(),
+				'EXM_type'  => $this->get_model()->get_this_model_name(),
+			)
+		);
+		$new_extra_meta->save();
+		return true;
+	}
+
+
+	/**
+	 * Deletes all the extra meta rows for this record as specified by key. If $meta_value
+	 * is specified, only deletes extra meta records with that value.
+	 *
+	 * @param string $meta_key
+	 * @param mixed  $meta_value
+	 * @return int number of extra meta rows deleted
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_extra_meta($meta_key, $meta_value = null)
+	{
+		$query_params = array(
+			array(
+				'EXM_key'  => $meta_key,
+				'OBJ_ID'   => $this->ID(),
+				'EXM_type' => $this->get_model()->get_this_model_name(),
+			),
+		);
+		if ($meta_value !== null) {
+			$query_params[0]['EXM_value'] = $meta_value;
+		}
+		return EEM_Extra_Meta::instance()->delete($query_params);
+	}
+
+
+	/**
+	 * Gets the extra meta with the given meta key. If you specify "single" we just return 1, otherwise
+	 * an array of everything found. Requires that this model actually have a relation of type EE_Has_Many_Any_Relation.
+	 * You can specify $default is case you haven't found the extra meta
+	 *
+	 * @param string  $meta_key
+	 * @param boolean $single
+	 * @param mixed   $default if we don't find anything, what should we return?
+	 * @return mixed single value if $single; array if ! $single
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function get_extra_meta($meta_key, $single = false, $default = null)
+	{
+		if ($single) {
+			$result = $this->get_first_related(
+				'Extra_Meta',
+				array(array('EXM_key' => $meta_key))
+			);
+			if ($result instanceof EE_Extra_Meta) {
+				return $result->value();
+			}
+		} else {
+			$results = $this->get_many_related(
+				'Extra_Meta',
+				array(array('EXM_key' => $meta_key))
+			);
+			if ($results) {
+				$values = array();
+				foreach ($results as $result) {
+					if ($result instanceof EE_Extra_Meta) {
+						$values[ $result->ID() ] = $result->value();
+					}
+				}
+				return $values;
+			}
+		}
+		//if nothing discovered yet return default.
+		return apply_filters(
+			'FHEE__EE_Base_Class__get_extra_meta__default_value',
+			$default,
+			$meta_key,
+			$single,
+			$this
+		);
+	}
+
+
+	/**
+	 * Returns a simple array of all the extra meta associated with this model object.
+	 * If $one_of_each_key is true (Default), it will be an array of simple key-value pairs, keys being the
+	 * extra meta's key, and teh value being its value. However, if there are duplicate extra meta rows with
+	 * the same key, only one will be used. (eg array('foo'=>'bar','monkey'=>123))
+	 * If $one_of_each_key is false, it will return an array with the top-level keys being
+	 * the extra meta keys, but their values are also arrays, which have the extra-meta's ID as their sub-key, and
+	 * finally the extra meta's value as each sub-value. (eg
+	 * array('foo'=>array(1=>'bar',2=>'bill'),'monkey'=>array(3=>123)))
+	 *
+	 * @param boolean $one_of_each_key
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function all_extra_meta_array($one_of_each_key = true)
+	{
+		$return_array = array();
+		if ($one_of_each_key) {
+			$extra_meta_objs = $this->get_many_related(
+				'Extra_Meta',
+				array('group_by' => 'EXM_key')
+			);
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					$return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
+				}
+			}
+		} else {
+			$extra_meta_objs = $this->get_many_related('Extra_Meta');
+			foreach ($extra_meta_objs as $extra_meta_obj) {
+				if ($extra_meta_obj instanceof EE_Extra_Meta) {
+					if (! isset($return_array[ $extra_meta_obj->key() ])) {
+						$return_array[ $extra_meta_obj->key() ] = array();
+					}
+					$return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
+				}
+			}
+		}
+		return $return_array;
+	}
+
+
+	/**
+	 * Gets a pretty nice displayable nice for this model object. Often overridden
+	 *
+	 * @return string
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function name()
+	{
+		//find a field that's not a text field
+		$field_we_can_use = $this->get_model()->get_a_field_of_type('EE_Text_Field_Base');
+		if ($field_we_can_use) {
+			return $this->get($field_we_can_use->get_name());
+		}
+		$first_few_properties = $this->model_field_array();
+		$first_few_properties = array_slice($first_few_properties, 0, 3);
+		$name_parts           = array();
+		foreach ($first_few_properties as $name => $value) {
+			$name_parts[] = "$name:$value";
+		}
+		return implode(',', $name_parts);
+	}
+
+
+	/**
+	 * in_entity_map
+	 * Checks if this model object has been proven to already be in the entity map
+	 *
+	 * @return boolean
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function in_entity_map()
+	{
+		// well, if we looked, did we find it in the entity map?
+		return $this->ID() && $this->get_model()->get_from_entity_map($this->ID()) === $this;
+	}
+
+
+	/**
+	 * refresh_from_db
+	 * Makes sure the fields and values on this model object are in-sync with what's in the database.
+	 *
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error if this model object isn't in the entity mapper (because then you should
+	 * just use what's in the entity mapper and refresh it) and WP_DEBUG is TRUE
+	 */
+	public function refresh_from_db()
+	{
+		if ($this->ID() && $this->in_entity_map()) {
+			$this->get_model()->refresh_entity_map_from_db($this->ID());
+		} else {
+			//if it doesn't have ID, you shouldn't be asking to refresh it from teh database (because its not in the database)
+			//if it has an ID but it's not in the map, and you're asking me to refresh it
+			//that's kinda dangerous. You should just use what's in the entity map, or add this to the entity map if there's
+			//absolutely nothing in it for this ID
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
+							'event_espresso'),
+						$this->ID(),
+						get_class($this->get_model()) . '::instance()->add_to_entity_map()',
+						get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+					)
+				);
+			}
+		}
+	}
+
+
+	/**
+	 * Because some other plugins, like Advanced Cron Manager, expect all objects to have this method
+	 * (probably a bad assumption they have made, oh well)
+	 *
+	 * @return string
+	 */
+	public function __toString()
+	{
+		try {
+			return sprintf('%s (%s)', $this->name(), $this->ID());
+		} catch (Exception $e) {
+			EE_Error::add_error($e->getMessage(), __FILE__, __FUNCTION__, __LINE__);
+			return '';
+		}
+	}
+
+
+	/**
+	 * Clear related model objects if they're already in the DB, because otherwise when we
+	 * UN-serialize this model object we'll need to be careful to add them to the entity map.
+	 * This means if we have made changes to those related model objects, and want to unserialize
+	 * the this model object on a subsequent request, changes to those related model objects will be lost.
+	 * Instead, those related model objects should be directly serialized and stored.
+	 * Eg, the following won't work:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $reg = get_option( 'my_option' );
+	 * $reg->attendee()->save();
+	 * And would need to be replace with:
+	 * $reg = EEM_Registration::instance()->get_one_by_ID( 123 );
+	 * $att = $reg->attendee();
+	 * $att->set( 'ATT_fname', 'Dirk' );
+	 * update_option( 'my_option', serialize( $reg ) );
+	 * //END REQUEST
+	 * //START NEXT REQUEST
+	 * $att = get_option( 'my_option' );
+	 * $att->save();
+	 *
+	 * @return array
+	 * @throws ReflectionException
+	 * @throws InvalidArgumentException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidDataTypeException
+	 * @throws EE_Error
+	 */
+	public function __sleep()
+	{
+		$model = $this->get_model();
+		foreach ($model->relation_settings() as $relation_name => $relation_obj) {
+			if ($relation_obj instanceof EE_Belongs_To_Relation) {
+				$classname = 'EE_' . $model->get_this_model_name();
+				if (
+					$this->get_one_from_cache($relation_name) instanceof $classname
+					&& $this->get_one_from_cache($relation_name)->ID()
+				) {
+					$this->clear_cache(
+						$relation_name,
+						$this->get_one_from_cache($relation_name)->ID()
+					);
+				}
+			}
+		}
+		$this->_props_n_values_provided_in_constructor = array();
+		$properties_to_serialize                       = get_object_vars($this);
+		//don't serialize the model. It's big and that risks recursion
+		unset($properties_to_serialize['_model']);
+		return array_keys($properties_to_serialize);
+	}
+
+
+	/**
+	 * restore _props_n_values_provided_in_constructor
+	 * PLZ NOTE: this will reset the array to whatever fields values were present prior to serialization,
+	 * and therefore should NOT be used to determine if state change has occurred since initial construction.
+	 * At best, you would only be able to detect if state change has occurred during THIS request.
+	 */
+	public function __wakeup()
+	{
+		$this->_props_n_values_provided_in_constructor = $this->_fields;
+	}
 }
 
 

Spacing +117 added lines, -117 removed lines

@@ -148,7 +148,7 @@ 
         $fieldValues = is_array($fieldValues) ? $fieldValues : array($fieldValues);
         // verify client code has not passed any invalid field names
         foreach ($fieldValues as $field_name => $field_value) {
-            if (! isset($model_fields[ $field_name ])) {
+            if ( ! isset($model_fields[$field_name])) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -163,7 +163,7 @@ 
             }
         }
         $this->_timezone = EEH_DTT_Helper::get_valid_timezone_string($timezone);
-        if (! empty($date_formats) && is_array($date_formats)) {
+        if ( ! empty($date_formats) && is_array($date_formats)) {
             list($this->_dt_frmt, $this->_tm_frmt) = $date_formats;
         } else {
             //set default formats for date and time
@@ -176,7 +176,7 @@ 
             foreach ($model_fields as $fieldName => $field) {
                 $this->set_from_db(
                     $fieldName,
-                    isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null
+                    isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null
                 );
             }
         } else {
@@ -185,22 +185,22 @@ 
             foreach ($model_fields as $fieldName => $field) {
                 $this->set(
                     $fieldName,
-                    isset($fieldValues[ $fieldName ]) ? $fieldValues[ $fieldName ] : null, true
+                    isset($fieldValues[$fieldName]) ? $fieldValues[$fieldName] : null, true
                 );
             }
         }
         //remember what values were passed to this constructor
         $this->_props_n_values_provided_in_constructor = $fieldValues;
         //remember in entity mapper
-        if (! $bydb && $model->has_primary_key_field() && $this->ID()) {
+        if ( ! $bydb && $model->has_primary_key_field() && $this->ID()) {
             $model->add_to_entity_map($this);
         }
         //setup all the relations
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $this->_model_relations[ $relation_name ] = null;
+                $this->_model_relations[$relation_name] = null;
             } else {
-                $this->_model_relations[ $relation_name ] = array();
+                $this->_model_relations[$relation_name] = array();
             }
         }
         /**
@@ -251,10 +251,10 @@ 
      */
     public function get_original($field_name)
     {
-        if (isset($this->_props_n_values_provided_in_constructor[ $field_name ])
+        if (isset($this->_props_n_values_provided_in_constructor[$field_name])
             && $field_settings = $this->get_model()->field_settings_for($field_name)
         ) {
-            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[ $field_name ]);
+            return $field_settings->prepare_for_get($this->_props_n_values_provided_in_constructor[$field_name]);
         }
         return null;
     }
@@ -291,7 +291,7 @@ 
         // then don't do anything
         if (
             ! $use_default
-            && $this->_fields[ $field_name ] === $field_value
+            && $this->_fields[$field_name] === $field_value
             && $this->ID()
         ) {
             return;
@@ -309,7 +309,7 @@ 
             $holder_of_value = $field_obj->prepare_for_set($field_value);
             //should the value be null?
             if (($field_value === null || $holder_of_value === null || $holder_of_value === '') && $use_default) {
-                $this->_fields[ $field_name ] = $field_obj->get_default_value();
+                $this->_fields[$field_name] = $field_obj->get_default_value();
                 /**
                  * To save having to refactor all the models, if a default value is used for a
                  * EE_Datetime_Field, and that value is not null nor is it a DateTime
@@ -320,15 +320,15 @@ 
                  */
                 if (
                     $field_obj instanceof EE_Datetime_Field
-                    && $this->_fields[ $field_name ] !== null
-                    && ! $this->_fields[ $field_name ] instanceof DateTime
+                    && $this->_fields[$field_name] !== null
+                    && ! $this->_fields[$field_name] instanceof DateTime
                 ) {
-                    empty($this->_fields[ $field_name ])
+                    empty($this->_fields[$field_name])
                         ? $this->set($field_name, time())
-                        : $this->set($field_name, $this->_fields[ $field_name ]);
+                        : $this->set($field_name, $this->_fields[$field_name]);
                 }
             } else {
-                $this->_fields[ $field_name ] = $holder_of_value;
+                $this->_fields[$field_name] = $holder_of_value;
             }
             //if we're not in the constructor...
             //now check if what we set was a primary key
@@ -345,7 +345,7 @@ 
                 $fields_on_model = self::_get_model(get_class($this))->field_settings();
                 $obj_in_db       = self::_get_model(get_class($this))->get_one_by_ID($field_value);
                 foreach ($fields_on_model as $field_obj) {
-                    if (! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
+                    if ( ! array_key_exists($field_obj->get_name(), $this->_props_n_values_provided_in_constructor)
                         && $field_obj->get_name() !== $field_name
                     ) {
                         $this->set($field_obj->get_name(), $obj_in_db->get($field_obj->get_name()));
@@ -390,8 +390,8 @@ 
      */
     public function getCustomSelect($alias)
     {
-        return isset($this->custom_selection_results[ $alias ])
-            ? $this->custom_selection_results[ $alias ]
+        return isset($this->custom_selection_results[$alias])
+            ? $this->custom_selection_results[$alias]
             : null;
     }
 
@@ -478,8 +478,8 @@ 
         foreach ($model_fields as $field_name => $field_obj) {
             if ($field_obj instanceof EE_Datetime_Field) {
                 $field_obj->set_timezone($this->_timezone);
-                if (isset($this->_fields[ $field_name ]) && $this->_fields[ $field_name ] instanceof DateTime) {
-                    $this->_fields[ $field_name ]->setTimezone(new DateTimeZone($this->_timezone));
+                if (isset($this->_fields[$field_name]) && $this->_fields[$field_name] instanceof DateTime) {
+                    $this->_fields[$field_name]->setTimezone(new DateTimeZone($this->_timezone));
                 }
             }
         }
@@ -537,7 +537,7 @@ 
      */
     public function get_format($full = true)
     {
-        return $full ? $this->_dt_frmt . ' ' . $this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
+        return $full ? $this->_dt_frmt.' '.$this->_tm_frmt : array($this->_dt_frmt, $this->_tm_frmt);
     }
 
 
@@ -563,11 +563,11 @@ 
     public function cache($relationName = '', $object_to_cache = null, $cache_id = null)
     {
         // its entirely possible that there IS no related object yet in which case there is nothing to cache.
-        if (! $object_to_cache instanceof EE_Base_Class) {
+        if ( ! $object_to_cache instanceof EE_Base_Class) {
             return false;
         }
         // also get "how" the object is related, or throw an error
-        if (! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
+        if ( ! $relationship_to_model = $this->get_model()->related_settings_for($relationName)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no relationship to %s on a %s. Cannot cache it', 'event_espresso'),
@@ -581,38 +581,38 @@ 
             // if it's a "belongs to" relationship, then there's only one related model object
             // eg, if this is a registration, there's only 1 attendee for it
             // so for these model objects just set it to be cached
-            $this->_model_relations[ $relationName ] = $object_to_cache;
+            $this->_model_relations[$relationName] = $object_to_cache;
             $return                                  = true;
         } else {
             // otherwise, this is the "many" side of a one to many relationship,
             // so we'll add the object to the array of related objects for that type.
             // eg: if this is an event, there are many registrations for that event,
             // so we cache the registrations in an array
-            if (! is_array($this->_model_relations[ $relationName ])) {
+            if ( ! is_array($this->_model_relations[$relationName])) {
                 // if for some reason, the cached item is a model object,
                 // then stick that in the array, otherwise start with an empty array
-                $this->_model_relations[ $relationName ] = $this->_model_relations[ $relationName ]
+                $this->_model_relations[$relationName] = $this->_model_relations[$relationName]
                                                            instanceof
                                                            EE_Base_Class
-                    ? array($this->_model_relations[ $relationName ]) : array();
+                    ? array($this->_model_relations[$relationName]) : array();
             }
             // first check for a cache_id which is normally empty
-            if (! empty($cache_id)) {
+            if ( ! empty($cache_id)) {
                 // if the cache_id exists, then it means we are purposely trying to cache this
                 // with a known key that can then be used to retrieve the object later on
-                $this->_model_relations[ $relationName ][ $cache_id ] = $object_to_cache;
+                $this->_model_relations[$relationName][$cache_id] = $object_to_cache;
                 $return                                               = $cache_id;
             } elseif ($object_to_cache->ID()) {
                 // OR the cached object originally came from the db, so let's just use it's PK for an ID
-                $this->_model_relations[ $relationName ][ $object_to_cache->ID() ] = $object_to_cache;
+                $this->_model_relations[$relationName][$object_to_cache->ID()] = $object_to_cache;
                 $return                                                            = $object_to_cache->ID();
             } else {
                 // OR it's a new object with no ID, so just throw it in the array with an auto-incremented ID
-                $this->_model_relations[ $relationName ][] = $object_to_cache;
+                $this->_model_relations[$relationName][] = $object_to_cache;
                 // move the internal pointer to the end of the array
-                end($this->_model_relations[ $relationName ]);
+                end($this->_model_relations[$relationName]);
                 // and grab the key so that we can return it
-                $return = key($this->_model_relations[ $relationName ]);
+                $return = key($this->_model_relations[$relationName]);
             }
         }
         return $return;
@@ -638,7 +638,7 @@ 
         //first make sure this property exists
         $this->get_model()->field_settings_for($fieldname);
         $cache_type                                            = empty($cache_type) ? 'standard' : $cache_type;
-        $this->_cached_properties[ $fieldname ][ $cache_type ] = $value;
+        $this->_cached_properties[$fieldname][$cache_type] = $value;
     }
 
 
@@ -667,9 +667,9 @@ 
         $model = $this->get_model();
         $model->field_settings_for($fieldname);
         $cache_type = $pretty ? 'pretty' : 'standard';
-        $cache_type .= ! empty($extra_cache_ref) ? '_' . $extra_cache_ref : '';
-        if (isset($this->_cached_properties[ $fieldname ][ $cache_type ])) {
-            return $this->_cached_properties[ $fieldname ][ $cache_type ];
+        $cache_type .= ! empty($extra_cache_ref) ? '_'.$extra_cache_ref : '';
+        if (isset($this->_cached_properties[$fieldname][$cache_type])) {
+            return $this->_cached_properties[$fieldname][$cache_type];
         }
         $value = $this->_get_fresh_property($fieldname, $pretty, $extra_cache_ref);
         $this->_set_cached_property($fieldname, $value, $cache_type);
@@ -697,12 +697,12 @@ 
         if ($field_obj instanceof EE_Datetime_Field) {
             $this->_prepare_datetime_field($field_obj, $pretty, $extra_cache_ref);
         }
-        if (! isset($this->_fields[ $fieldname ])) {
-            $this->_fields[ $fieldname ] = null;
+        if ( ! isset($this->_fields[$fieldname])) {
+            $this->_fields[$fieldname] = null;
         }
         $value = $pretty
-            ? $field_obj->prepare_for_pretty_echoing($this->_fields[ $fieldname ], $extra_cache_ref)
-            : $field_obj->prepare_for_get($this->_fields[ $fieldname ]);
+            ? $field_obj->prepare_for_pretty_echoing($this->_fields[$fieldname], $extra_cache_ref)
+            : $field_obj->prepare_for_get($this->_fields[$fieldname]);
         return $value;
     }
 
@@ -760,8 +760,8 @@ 
      */
     protected function _clear_cached_property($property_name)
     {
-        if (isset($this->_cached_properties[ $property_name ])) {
-            unset($this->_cached_properties[ $property_name ]);
+        if (isset($this->_cached_properties[$property_name])) {
+            unset($this->_cached_properties[$property_name]);
         }
     }
 
@@ -813,7 +813,7 @@ 
     {
         $relationship_to_model = $this->get_model()->related_settings_for($relationName);
         $index_in_cache        = '';
-        if (! $relationship_to_model) {
+        if ( ! $relationship_to_model) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('There is no relationship to %s on a %s. Cannot clear that cache', 'event_espresso'),
@@ -824,21 +824,21 @@ 
         }
         if ($clear_all) {
             $obj_removed                             = true;
-            $this->_model_relations[ $relationName ] = null;
+            $this->_model_relations[$relationName] = null;
         } elseif ($relationship_to_model instanceof EE_Belongs_To_Relation) {
-            $obj_removed                             = $this->_model_relations[ $relationName ];
-            $this->_model_relations[ $relationName ] = null;
+            $obj_removed                             = $this->_model_relations[$relationName];
+            $this->_model_relations[$relationName] = null;
         } else {
             if ($object_to_remove_or_index_into_array instanceof EE_Base_Class
                 && $object_to_remove_or_index_into_array->ID()
             ) {
                 $index_in_cache = $object_to_remove_or_index_into_array->ID();
-                if (is_array($this->_model_relations[ $relationName ])
-                    && ! isset($this->_model_relations[ $relationName ][ $index_in_cache ])
+                if (is_array($this->_model_relations[$relationName])
+                    && ! isset($this->_model_relations[$relationName][$index_in_cache])
                 ) {
                     $index_found_at = null;
                     //find this object in the array even though it has a different key
-                    foreach ($this->_model_relations[ $relationName ] as $index => $obj) {
+                    foreach ($this->_model_relations[$relationName] as $index => $obj) {
                         /** @noinspection TypeUnsafeComparisonInspection */
                         if (
                             $obj instanceof EE_Base_Class
@@ -872,9 +872,9 @@ 
             }
             //supposedly we've found it. But it could just be that the client code
             //provided a bad index/object
-            if (isset($this->_model_relations[ $relationName ][ $index_in_cache ])) {
-                $obj_removed = $this->_model_relations[ $relationName ][ $index_in_cache ];
-                unset($this->_model_relations[ $relationName ][ $index_in_cache ]);
+            if (isset($this->_model_relations[$relationName][$index_in_cache])) {
+                $obj_removed = $this->_model_relations[$relationName][$index_in_cache];
+                unset($this->_model_relations[$relationName][$index_in_cache]);
             } else {
                 //that thing was never cached anyways.
                 $obj_removed = null;
@@ -905,7 +905,7 @@ 
         $current_cache_id = ''
     ) {
         // verify that incoming object is of the correct type
-        $obj_class = 'EE_' . $relationName;
+        $obj_class = 'EE_'.$relationName;
         if ($newly_saved_object instanceof $obj_class) {
             /* @type EE_Base_Class $newly_saved_object */
             // now get the type of relation
@@ -913,17 +913,17 @@ 
             // if this is a 1:1 relationship
             if ($relationship_to_model instanceof EE_Belongs_To_Relation) {
                 // then just replace the cached object with the newly saved object
-                $this->_model_relations[ $relationName ] = $newly_saved_object;
+                $this->_model_relations[$relationName] = $newly_saved_object;
                 return true;
                 // or if it's some kind of sordid feral polyamorous relationship...
             }
-            if (is_array($this->_model_relations[ $relationName ])
-                      && isset($this->_model_relations[ $relationName ][ $current_cache_id ])
+            if (is_array($this->_model_relations[$relationName])
+                      && isset($this->_model_relations[$relationName][$current_cache_id])
             ) {
                 // then remove the current cached item
-                unset($this->_model_relations[ $relationName ][ $current_cache_id ]);
+                unset($this->_model_relations[$relationName][$current_cache_id]);
                 // and cache the newly saved object using it's new ID
-                $this->_model_relations[ $relationName ][ $newly_saved_object->ID() ] = $newly_saved_object;
+                $this->_model_relations[$relationName][$newly_saved_object->ID()] = $newly_saved_object;
                 return true;
             }
         }
@@ -940,8 +940,8 @@ 
      */
     public function get_one_from_cache($relationName)
     {
-        $cached_array_or_object = isset($this->_model_relations[ $relationName ])
-            ? $this->_model_relations[ $relationName ]
+        $cached_array_or_object = isset($this->_model_relations[$relationName])
+            ? $this->_model_relations[$relationName]
             : null;
         if (is_array($cached_array_or_object)) {
             return array_shift($cached_array_or_object);
@@ -964,7 +964,7 @@ 
      */
     public function get_all_from_cache($relationName)
     {
-        $objects = isset($this->_model_relations[ $relationName ]) ? $this->_model_relations[ $relationName ] : array();
+        $objects = isset($this->_model_relations[$relationName]) ? $this->_model_relations[$relationName] : array();
         // if the result is not an array, but exists, make it an array
         $objects = is_array($objects) ? $objects : array($objects);
         //bugfix for https://events.codebasehq.com/projects/event-espresso/tickets/7143
@@ -1148,7 +1148,7 @@ 
             } else {
                 $field_value = $field_obj->prepare_for_set_from_db($field_value_from_db);
             }
-            $this->_fields[ $field_name ] = $field_value;
+            $this->_fields[$field_name] = $field_value;
             $this->_clear_cached_property($field_name);
         }
     }
@@ -1188,9 +1188,9 @@ 
     public function get_raw($field_name)
     {
         $field_settings = $this->get_model()->field_settings_for($field_name);
-        return $field_settings instanceof EE_Datetime_Field && $this->_fields[ $field_name ] instanceof DateTime
-            ? $this->_fields[ $field_name ]->format('U')
-            : $this->_fields[ $field_name ];
+        return $field_settings instanceof EE_Datetime_Field && $this->_fields[$field_name] instanceof DateTime
+            ? $this->_fields[$field_name]->format('U')
+            : $this->_fields[$field_name];
     }
 
 
@@ -1213,7 +1213,7 @@ 
     public function get_DateTime_object($field_name)
     {
         $field_settings = $this->get_model()->field_settings_for($field_name);
-        if (! $field_settings instanceof EE_Datetime_Field) {
+        if ( ! $field_settings instanceof EE_Datetime_Field) {
             EE_Error::add_error(
                 sprintf(
                     esc_html__(
@@ -1228,7 +1228,7 @@ 
             );
             return false;
         }
-        return $this->_fields[ $field_name ];
+        return $this->_fields[$field_name];
     }
 
 
@@ -1469,7 +1469,7 @@ 
      */
     public function get_i18n_datetime($field_name, $format = '')
     {
-        $format = empty($format) ? $this->_dt_frmt . ' ' . $this->_tm_frmt : $format;
+        $format = empty($format) ? $this->_dt_frmt.' '.$this->_tm_frmt : $format;
         return date_i18n(
             $format,
             EEH_DTT_Helper::get_timestamp_with_offset(
@@ -1581,19 +1581,19 @@ 
         $field->set_time_format($this->_tm_frmt);
         switch ($what) {
             case 'T' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_time(
+                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_time(
                     $datetime_value,
-                    $this->_fields[ $fieldname ]
+                    $this->_fields[$fieldname]
                 );
                 break;
             case 'D' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set_with_new_date(
+                $this->_fields[$fieldname] = $field->prepare_for_set_with_new_date(
                     $datetime_value,
-                    $this->_fields[ $fieldname ]
+                    $this->_fields[$fieldname]
                 );
                 break;
             case 'B' :
-                $this->_fields[ $fieldname ] = $field->prepare_for_set($datetime_value);
+                $this->_fields[$fieldname] = $field->prepare_for_set($datetime_value);
                 break;
         }
         $this->_clear_cached_property($fieldname);
@@ -1635,7 +1635,7 @@ 
         $this->set_timezone($timezone);
         $fn   = (array) $field_name;
         $args = array_merge($fn, (array) $args);
-        if (! method_exists($this, $callback)) {
+        if ( ! method_exists($this, $callback)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -1647,7 +1647,7 @@ 
             );
         }
         $args   = (array) $args;
-        $return = $prepend . call_user_func_array(array($this, $callback), $args) . $append;
+        $return = $prepend.call_user_func_array(array($this, $callback), $args).$append;
         $this->set_timezone($original_timezone);
         return $return;
     }
@@ -1762,8 +1762,8 @@ 
     {
         $model = $this->get_model();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
-            if (! empty($this->_model_relations[ $relation_name ])) {
-                $related_objects = $this->_model_relations[ $relation_name ];
+            if ( ! empty($this->_model_relations[$relation_name])) {
+                $related_objects = $this->_model_relations[$relation_name];
                 if ($relation_obj instanceof EE_Belongs_To_Relation) {
                     //this relation only stores a single model object, not an array
                     //but let's make it consistent
@@ -1820,7 +1820,7 @@ 
             $this->set($column, $value);
         }
         // no changes ? then don't do anything
-        if (! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
+        if ( ! $this->_has_changes && $this->ID() && $model->get_primary_key_field()->is_auto_increment()) {
             return 0;
         }
         /**
@@ -1830,7 +1830,7 @@ 
          * @param EE_Base_Class $model_object the model object about to be saved.
          */
         do_action('AHEE__EE_Base_Class__save__begin', $this);
-        if (! $this->allow_persist()) {
+        if ( ! $this->allow_persist()) {
             return 0;
         }
         // now get current attribute values
@@ -1845,10 +1845,10 @@ 
         if ($model->has_primary_key_field()) {
             if ($model->get_primary_key_field()->is_auto_increment()) {
                 //ok check if it's set, if so: update; if not, insert
-                if (! empty($save_cols_n_values[ $model->primary_key_name() ])) {
+                if ( ! empty($save_cols_n_values[$model->primary_key_name()])) {
                     $results = $model->update_by_ID($save_cols_n_values, $this->ID());
                 } else {
-                    unset($save_cols_n_values[ $model->primary_key_name() ]);
+                    unset($save_cols_n_values[$model->primary_key_name()]);
                     $results = $model->insert($save_cols_n_values);
                     if ($results) {
                         //if successful, set the primary key
@@ -1858,7 +1858,7 @@ 
                         //will get added to the mapper before we can add this one!
                         //but if we just avoid using the SET method, all that headache can be avoided
                         $pk_field_name                   = $model->primary_key_name();
-                        $this->_fields[ $pk_field_name ] = $results;
+                        $this->_fields[$pk_field_name] = $results;
                         $this->_clear_cached_property($pk_field_name);
                         $model->add_to_entity_map($this);
                         $this->_update_cached_related_model_objs_fks();
@@ -1875,8 +1875,8 @@ 
                                     'event_espresso'
                                 ),
                                 get_class($this),
-                                get_class($model) . '::instance()->add_to_entity_map()',
-                                get_class($model) . '::instance()->get_one_by_ID()',
+                                get_class($model).'::instance()->add_to_entity_map()',
+                                get_class($model).'::instance()->get_one_by_ID()',
                                 '<br />'
                             )
                         );
@@ -1976,27 +1976,27 @@ 
     public function save_new_cached_related_model_objs()
     {
         //make sure this has been saved
-        if (! $this->ID()) {
+        if ( ! $this->ID()) {
             $id = $this->save();
         } else {
             $id = $this->ID();
         }
         //now save all the NEW cached model objects  (ie they don't exist in the DB)
         foreach ($this->get_model()->relation_settings() as $relationName => $relationObj) {
-            if ($this->_model_relations[ $relationName ]) {
+            if ($this->_model_relations[$relationName]) {
                 //is this a relation where we should expect just ONE related object (ie, EE_Belongs_To_relation)
                 //or MANY related objects (ie, EE_HABTM_Relation or EE_Has_Many_Relation)?
                 /* @var $related_model_obj EE_Base_Class */
                 if ($relationObj instanceof EE_Belongs_To_Relation) {
                     //add a relation to that relation type (which saves the appropriate thing in the process)
                     //but ONLY if it DOES NOT exist in the DB
-                    $related_model_obj = $this->_model_relations[ $relationName ];
+                    $related_model_obj = $this->_model_relations[$relationName];
                     //					if( ! $related_model_obj->ID()){
                     $this->_add_relation_to($related_model_obj, $relationName);
                     $related_model_obj->save_new_cached_related_model_objs();
                     //					}
                 } else {
-                    foreach ($this->_model_relations[ $relationName ] as $related_model_obj) {
+                    foreach ($this->_model_relations[$relationName] as $related_model_obj) {
                         //add a relation to that relation type (which saves the appropriate thing in the process)
                         //but ONLY if it DOES NOT exist in the DB
                         //						if( ! $related_model_obj->ID()){
@@ -2023,7 +2023,7 @@ 
      */
     public function get_model()
     {
-        if (! $this->_model) {
+        if ( ! $this->_model) {
             $modelName    = self::_get_model_classname(get_class($this));
             $this->_model = self::_get_model_instance_with_name($modelName, $this->_timezone);
         } else {
@@ -2049,9 +2049,9 @@ 
         $primary_id_ref = self::_get_primary_key_name($classname);
         if (
             array_key_exists($primary_id_ref, $props_n_values)
-            && ! empty($props_n_values[ $primary_id_ref ])
+            && ! empty($props_n_values[$primary_id_ref])
         ) {
-            $id = $props_n_values[ $primary_id_ref ];
+            $id = $props_n_values[$primary_id_ref];
             return self::_get_model($classname)->get_from_entity_map($id);
         }
         return false;
@@ -2085,10 +2085,10 @@ 
         if ($model->has_primary_key_field()) {
             $primary_id_ref = self::_get_primary_key_name($classname);
             if (array_key_exists($primary_id_ref, $props_n_values)
-                && ! empty($props_n_values[ $primary_id_ref ])
+                && ! empty($props_n_values[$primary_id_ref])
             ) {
                 $existing = $model->get_one_by_ID(
-                    $props_n_values[ $primary_id_ref ]
+                    $props_n_values[$primary_id_ref]
                 );
             }
         } elseif ($model->has_all_combined_primary_key_fields($props_n_values)) {
@@ -2100,7 +2100,7 @@ 
         }
         if ($existing) {
             //set date formats if present before setting values
-            if (! empty($date_formats) && is_array($date_formats)) {
+            if ( ! empty($date_formats) && is_array($date_formats)) {
                 $existing->set_date_format($date_formats[0]);
                 $existing->set_time_format($date_formats[1]);
             } else {
@@ -2133,7 +2133,7 @@ 
     protected static function _get_model($classname, $timezone = null)
     {
         //find model for this class
-        if (! $classname) {
+        if ( ! $classname) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2182,7 +2182,7 @@ 
         if (strpos($model_name, 'EE_') === 0) {
             $model_classname = str_replace('EE_', 'EEM_', $model_name);
         } else {
-            $model_classname = 'EEM_' . $model_name;
+            $model_classname = 'EEM_'.$model_name;
         }
         return $model_classname;
     }
@@ -2201,7 +2201,7 @@ 
      */
     protected static function _get_primary_key_name($classname = null)
     {
-        if (! $classname) {
+        if ( ! $classname) {
             throw new EE_Error(
                 sprintf(
                     esc_html__('What were you thinking calling _get_primary_key_name(%s)', 'event_espresso'),
@@ -2231,7 +2231,7 @@ 
         $model = $this->get_model();
         //now that we know the name of the variable, use a variable variable to get its value and return its
         if ($model->has_primary_key_field()) {
-            return $this->_fields[ $model->primary_key_name() ];
+            return $this->_fields[$model->primary_key_name()];
         }
         return $model->get_index_primary_key_string($this->_fields);
     }
@@ -2284,7 +2284,7 @@ 
             }
         } else {
             //this thing doesn't exist in the DB,  so just cache it
-            if (! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
+            if ( ! $otherObjectModelObjectOrID instanceof EE_Base_Class) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2449,7 +2449,7 @@ 
             } else {
                 //did we already cache the result of this query?
                 $cached_results = $this->get_all_from_cache($relationName);
-                if (! $cached_results) {
+                if ( ! $cached_results) {
                     $related_model_objects = $this->get_model()->get_all_related(
                         $this,
                         $relationName,
@@ -2559,7 +2559,7 @@ 
             } else {
                 //first, check if we've already cached the result of this query
                 $cached_result = $this->get_one_from_cache($relationName);
-                if (! $cached_result) {
+                if ( ! $cached_result) {
                     $related_model_object = $model->get_first_related(
                         $this,
                         $relationName,
@@ -2583,7 +2583,7 @@ 
             }
             // this doesn't exist in the DB and apparently the thing it belongs to doesn't either,
             // just get what's cached on this object
-            if (! $related_model_object) {
+            if ( ! $related_model_object) {
                 $related_model_object = $this->get_one_from_cache($relationName);
             }
         }
@@ -2665,7 +2665,7 @@ 
      */
     public function is_set($field_name)
     {
-        return isset($this->_fields[ $field_name ]);
+        return isset($this->_fields[$field_name]);
     }
 
 
@@ -2681,7 +2681,7 @@ 
     {
         foreach ((array) $properties as $property_name) {
             //first make sure this property exists
-            if (! $this->_fields[ $property_name ]) {
+            if ( ! $this->_fields[$property_name]) {
                 throw new EE_Error(
                     sprintf(
                         esc_html__(
@@ -2713,7 +2713,7 @@ 
         $properties = array();
         //remove prepended underscore
         foreach ($fields as $field_name => $settings) {
-            $properties[ $field_name ] = $this->get($field_name);
+            $properties[$field_name] = $this->get($field_name);
         }
         return $properties;
     }
@@ -2750,7 +2750,7 @@ 
     {
         $className = get_class($this);
         $tagName   = "FHEE__{$className}__{$methodName}";
-        if (! has_filter($tagName)) {
+        if ( ! has_filter($tagName)) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -2795,7 +2795,7 @@ 
             $query_params[0]['EXM_value'] = $meta_value;
         }
         $existing_rows_like_that = EEM_Extra_Meta::instance()->get_all($query_params);
-        if (! $existing_rows_like_that) {
+        if ( ! $existing_rows_like_that) {
             return $this->add_extra_meta($meta_key, $meta_value);
         }
         foreach ($existing_rows_like_that as $existing_row) {
@@ -2913,7 +2913,7 @@ 
                 $values = array();
                 foreach ($results as $result) {
                     if ($result instanceof EE_Extra_Meta) {
-                        $values[ $result->ID() ] = $result->value();
+                        $values[$result->ID()] = $result->value();
                     }
                 }
                 return $values;
@@ -2958,17 +2958,17 @@ 
             );
             foreach ($extra_meta_objs as $extra_meta_obj) {
                 if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    $return_array[ $extra_meta_obj->key() ] = $extra_meta_obj->value();
+                    $return_array[$extra_meta_obj->key()] = $extra_meta_obj->value();
                 }
             }
         } else {
             $extra_meta_objs = $this->get_many_related('Extra_Meta');
             foreach ($extra_meta_objs as $extra_meta_obj) {
                 if ($extra_meta_obj instanceof EE_Extra_Meta) {
-                    if (! isset($return_array[ $extra_meta_obj->key() ])) {
-                        $return_array[ $extra_meta_obj->key() ] = array();
+                    if ( ! isset($return_array[$extra_meta_obj->key()])) {
+                        $return_array[$extra_meta_obj->key()] = array();
                     }
-                    $return_array[ $extra_meta_obj->key() ][ $extra_meta_obj->ID() ] = $extra_meta_obj->value();
+                    $return_array[$extra_meta_obj->key()][$extra_meta_obj->ID()] = $extra_meta_obj->value();
                 }
             }
         }
@@ -3047,8 +3047,8 @@ 
                         esc_html__('Trying to refresh a model object with ID "%1$s" that\'s not in the entity map? First off: you should put it in the entity map by calling %2$s. Second off, if you want what\'s in the database right now, you should just call %3$s yourself and discard this model object.',
                             'event_espresso'),
                         $this->ID(),
-                        get_class($this->get_model()) . '::instance()->add_to_entity_map()',
-                        get_class($this->get_model()) . '::instance()->refresh_entity_map()'
+                        get_class($this->get_model()).'::instance()->add_to_entity_map()',
+                        get_class($this->get_model()).'::instance()->refresh_entity_map()'
                     )
                 );
             }
@@ -3110,7 +3110,7 @@ 
         $model = $this->get_model();
         foreach ($model->relation_settings() as $relation_name => $relation_obj) {
             if ($relation_obj instanceof EE_Belongs_To_Relation) {
-                $classname = 'EE_' . $model->get_this_model_name();
+                $classname = 'EE_'.$model->get_this_model_name();
                 if (
                     $this->get_one_from_cache($relation_name) instanceof $classname
                     && $this->get_one_from_cache($relation_name)->ID()

Doc Comments +9 added lines, -9 removed lines

@@ -712,7 +712,7 @@ 
      *
      * @param \EE_Datetime_Field $datetime_field
      * @param bool               $pretty
-     * @param null               $date_or_time
+     * @param string|null               $date_or_time
      * @return void
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -1066,7 +1066,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an array of EE_Base_Class objects is returned, otherwise
      *                                  you can indicate just the columns you want returned
      * @return array|EE_Base_Class
      * @throws ReflectionException
@@ -1095,7 +1095,7 @@ 
      *
      * @param null  $field_to_order_by  What field is being used as the reference point.
      * @param array $query_params       Any additional conditions on the query.
-     * @param null  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
+     * @param string  $columns_to_select  If left null, then an EE_Base_Class object is returned, otherwise
      *                                  you can indicate just the column you want returned
      * @return array|EE_Base_Class
      * @throws ReflectionException
@@ -1178,7 +1178,7 @@ 
      * This method simply returns the RAW unprocessed value for the given property in this class
      *
      * @param  string $field_name A valid fieldname
-     * @return mixed              Whatever the raw value stored on the property is.
+     * @return integer|null              Whatever the raw value stored on the property is.
      * @throws ReflectionException
      * @throws InvalidArgumentException
      * @throws InvalidInterfaceException
@@ -1526,7 +1526,7 @@ 
      * sets the time on a datetime property
      *
      * @access protected
-     * @param string|Datetime $time      a valid time string for php datetime functions (or DateTime object)
+     * @param string $time      a valid time string for php datetime functions (or DateTime object)
      * @param string          $fieldname the name of the field the time is being set on (must match a EE_Datetime_Field)
      * @throws ReflectionException
      * @throws InvalidArgumentException
@@ -1544,7 +1544,7 @@ 
      * sets the date on a datetime property
      *
      * @access protected
-     * @param string|DateTime $date      a valid date string for php datetime functions ( or DateTime object)
+     * @param string $date      a valid date string for php datetime functions ( or DateTime object)
      * @param string          $fieldname the name of the field the date is being set on (must match a EE_Datetime_Field)
      * @throws ReflectionException
      * @throws InvalidArgumentException
@@ -2066,7 +2066,7 @@ 
      *
      * @param  array  $props_n_values   incoming array of properties and their values
      * @param  string $classname        the classname of the child class
-     * @param null    $timezone
+     * @param string|null    $timezone
      * @param array   $date_formats     incoming date_formats in an array where the first value is the
      *                                  date_format and the second value is the time format
      * @return mixed (EE_Base_Class|bool)
@@ -2153,7 +2153,7 @@ 
      * Gets the model instance (eg instance of EEM_Attendee) given its classname (eg EE_Attendee)
      *
      * @param string $model_classname
-     * @param null   $timezone
+     * @param string|null   $timezone
      * @return EEM_Base
      * @throws ReflectionException
      * @throws InvalidArgumentException
@@ -2773,7 +2773,7 @@ 
      *
      * @param string $meta_key
      * @param mixed  $meta_value
-     * @param mixed  $previous_value
+     * @param boolean  $previous_value
      * @return bool|int # of records updated (or BOOLEAN if we actually ended up inserting the extra meta row)
      *                  NOTE: if the values haven't changed, returns 0
      * @throws InvalidArgumentException

core/middleware/EE_Recommended_Versions.core.php

Indentation +189 added lines, -189 removed lines

@@ -21,199 +21,199 @@
 {
 
 
-    /**
-     * converts a Request to a Response
-     *
-     * @param EE_Request  $request
-     * @param EE_Response $response
-     * @return EE_Response
-     * @throws InvalidDataTypeException
-     */
-    public function handle_request(EE_Request $request, EE_Response $response)
-    {
-        $this->_request  = $request;
-        $this->_response = $response;
-        //$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
-        //$this->_response->set_notice( 1, 'hey look at this' );
-        // check required WP version
-        if (! $this->_minimum_wp_version_required()) {
-            $this->_request->un_set('activate', true);
-            add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
-            //$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
-            $this->_response->terminate_request();
-            $this->_response->deactivate_plugin();
-        }
-        // check recommended PHP version
-        if (! $this->_minimum_php_version_recommended()) {
-            $this->_display_minimum_recommended_php_version_notice();
-        }
-
-        //upcoming required version
-        if (! $this->upcomingRequiredPhpVersion()) {
-            $this->displayUpcomingRequiredVersion();
-        }
-        $this->_response = $this->process_request_stack($this->_request, $this->_response);
-        //$this->_response->add_output( "\n\t OUT << " . __CLASS__ );
-        return $this->_response;
-    }
-
-
-    /**
-     * Helper method to assess installed wp version against given values.
-     * By default this compares the required minimum version of WP for EE against the installed version of WP
-     * Note, $wp_version is the first parameter sent into the PHP version_compare function (what is being checked
-     * against) so consider that when sending in your values.
-     *
-     * @param string $version_to_check
-     * @param string $operator
-     * @return bool
-     */
-    public static function check_wp_version($version_to_check = EE_MIN_WP_VER_REQUIRED, $operator = '>=')
-    {
-        global $wp_version;
-        return version_compare(
-            // first account for wp_version being pre-release
-            // (like RC, beta etc) which are usually in the format like 4.7-RC3-39519
-            strpos($wp_version, '-') > 0
-                ? substr($wp_version, 0, strpos($wp_version, '-'))
-                : $wp_version,
-            $version_to_check,
-            $operator
-        );
-    }
-
-
-
-    /**
-     *    _minimum_wp_version_required
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _minimum_wp_version_required()
-    {
-        return EE_Recommended_Versions::check_wp_version();
-    }
-
-
-
-    /**
-     *    _check_php_version
-     *
-     * @access private
-     * @param string $min_version
-     * @return boolean
-     */
-    private function _check_php_version($min_version = EE_MIN_PHP_VER_RECOMMENDED)
-    {
-        return version_compare(PHP_VERSION, $min_version, '>=');
-    }
-
-
-
-    /**
-     *    _minimum_php_version_recommended
-     *
-     * @access private
-     * @return boolean
-     */
-    private function _minimum_php_version_recommended()
-    {
-        return $this->_check_php_version();
-    }
-
-
-    /**
-     * Returns whether the provided php version number is greater than the current version of php installed on the server.
-     * @param string $version_required
-     * @return bool
-     */
-    private function upcomingRequiredPhpVersion($version_required = '5.4.45')
-    {
-        return $this->_check_php_version($version_required);
-    }
-
-
-
-    /**
-     *    minimum_wp_version_error
-     *
-     * @return void
-     */
-    public function minimum_wp_version_error()
-    {
-        global $wp_version;
-        ?>
+	/**
+	 * converts a Request to a Response
+	 *
+	 * @param EE_Request  $request
+	 * @param EE_Response $response
+	 * @return EE_Response
+	 * @throws InvalidDataTypeException
+	 */
+	public function handle_request(EE_Request $request, EE_Response $response)
+	{
+		$this->_request  = $request;
+		$this->_response = $response;
+		//$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
+		//$this->_response->set_notice( 1, 'hey look at this' );
+		// check required WP version
+		if (! $this->_minimum_wp_version_required()) {
+			$this->_request->un_set('activate', true);
+			add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
+			//$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
+			$this->_response->terminate_request();
+			$this->_response->deactivate_plugin();
+		}
+		// check recommended PHP version
+		if (! $this->_minimum_php_version_recommended()) {
+			$this->_display_minimum_recommended_php_version_notice();
+		}
+
+		//upcoming required version
+		if (! $this->upcomingRequiredPhpVersion()) {
+			$this->displayUpcomingRequiredVersion();
+		}
+		$this->_response = $this->process_request_stack($this->_request, $this->_response);
+		//$this->_response->add_output( "\n\t OUT << " . __CLASS__ );
+		return $this->_response;
+	}
+
+
+	/**
+	 * Helper method to assess installed wp version against given values.
+	 * By default this compares the required minimum version of WP for EE against the installed version of WP
+	 * Note, $wp_version is the first parameter sent into the PHP version_compare function (what is being checked
+	 * against) so consider that when sending in your values.
+	 *
+	 * @param string $version_to_check
+	 * @param string $operator
+	 * @return bool
+	 */
+	public static function check_wp_version($version_to_check = EE_MIN_WP_VER_REQUIRED, $operator = '>=')
+	{
+		global $wp_version;
+		return version_compare(
+			// first account for wp_version being pre-release
+			// (like RC, beta etc) which are usually in the format like 4.7-RC3-39519
+			strpos($wp_version, '-') > 0
+				? substr($wp_version, 0, strpos($wp_version, '-'))
+				: $wp_version,
+			$version_to_check,
+			$operator
+		);
+	}
+
+
+
+	/**
+	 *    _minimum_wp_version_required
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _minimum_wp_version_required()
+	{
+		return EE_Recommended_Versions::check_wp_version();
+	}
+
+
+
+	/**
+	 *    _check_php_version
+	 *
+	 * @access private
+	 * @param string $min_version
+	 * @return boolean
+	 */
+	private function _check_php_version($min_version = EE_MIN_PHP_VER_RECOMMENDED)
+	{
+		return version_compare(PHP_VERSION, $min_version, '>=');
+	}
+
+
+
+	/**
+	 *    _minimum_php_version_recommended
+	 *
+	 * @access private
+	 * @return boolean
+	 */
+	private function _minimum_php_version_recommended()
+	{
+		return $this->_check_php_version();
+	}
+
+
+	/**
+	 * Returns whether the provided php version number is greater than the current version of php installed on the server.
+	 * @param string $version_required
+	 * @return bool
+	 */
+	private function upcomingRequiredPhpVersion($version_required = '5.4.45')
+	{
+		return $this->_check_php_version($version_required);
+	}
+
+
+
+	/**
+	 *    minimum_wp_version_error
+	 *
+	 * @return void
+	 */
+	public function minimum_wp_version_error()
+	{
+		global $wp_version;
+		?>
         <div class="error">
             <p>
                 <?php
-                printf(
-                    __('We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.',
-                        'event_espresso'),
-                    EE_MIN_WP_VER_REQUIRED,
-                    $wp_version,
-                    '<br/>',
-                    '<a href="http://codex.wordpress.org/Updating_WordPress">http://codex.wordpress.org/Updating_WordPress</a>'
-                );
-                ?>
+				printf(
+					__('We\'re sorry, but Event Espresso requires WordPress version %1$s or greater in order to operate. You are currently running version %2$s.%3$sFor information on how to update your version of WordPress, please go to %4$s.',
+						'event_espresso'),
+					EE_MIN_WP_VER_REQUIRED,
+					$wp_version,
+					'<br/>',
+					'<a href="http://codex.wordpress.org/Updating_WordPress">http://codex.wordpress.org/Updating_WordPress</a>'
+				);
+				?>
             </p>
         </div>
         <?php
-    }
-
-
-
-    /**
-     *    _display_minimum_recommended_php_version_notice
-     *
-     * @access private
-     * @return void
-     * @throws InvalidDataTypeException
-     */
-    private function _display_minimum_recommended_php_version_notice()
-    {
-        if($this->_request->isAdmin()){
-            new PersistentAdminNotice(
-                'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
-                sprintf(
-                    __(
-                        'Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
-                        'event_espresso'
-                    ),
-                    EE_MIN_PHP_VER_RECOMMENDED,
-                    PHP_VERSION,
-                    '<br/>',
-                    '<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
-                )
-            );
-        }
-    }
-
-
-    /**
-     *  Sets a notice for an upcoming required version of PHP in the next update of EE core.
-     */
-    private function displayUpcomingRequiredVersion()
-    {
-        if ($this->_request->isAdmin()
-            && apply_filters('FHEE__EE_Recommended_Versions__displayUpcomingRequiredVersion', true, $this->_request)
-            && current_user_can('update_plugins')
-        ) {
-            add_action('admin_notices', function () {
-                echo '<div class="notice event-espresso-admin-notice notice-warning"><p>'
-                     . sprintf(
-                         esc_html__(
-                             'Please note: The next update of Event Espresso 4 will %1$srequire%2$s PHP 5.4.45 or greater.  Your web server\'s PHP version is %3$s.  You can contact your host and ask them to update your PHP version to at least PHP 5.6.  Please do not update to the new version of Event Espresso 4 until the PHP update is completed. Read about why keeping your server on the latest version of PHP is a good idea %4$shere%5$s',
-                             'event_espresso'
-                         ),
-                         '<strong>',
-                         '</strong>',
-                         PHP_VERSION,
-                         '<a href="https://wordpress.org/support/upgrade-php/">',
-                         '</a>'
-                     )
-                     . '</p></div>';
-            });
-        }
-    }
+	}
+
+
+
+	/**
+	 *    _display_minimum_recommended_php_version_notice
+	 *
+	 * @access private
+	 * @return void
+	 * @throws InvalidDataTypeException
+	 */
+	private function _display_minimum_recommended_php_version_notice()
+	{
+		if($this->_request->isAdmin()){
+			new PersistentAdminNotice(
+				'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
+				sprintf(
+					__(
+						'Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
+						'event_espresso'
+					),
+					EE_MIN_PHP_VER_RECOMMENDED,
+					PHP_VERSION,
+					'<br/>',
+					'<a href="http://php.net/downloads.php">http://php.net/downloads.php</a>'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 *  Sets a notice for an upcoming required version of PHP in the next update of EE core.
+	 */
+	private function displayUpcomingRequiredVersion()
+	{
+		if ($this->_request->isAdmin()
+			&& apply_filters('FHEE__EE_Recommended_Versions__displayUpcomingRequiredVersion', true, $this->_request)
+			&& current_user_can('update_plugins')
+		) {
+			add_action('admin_notices', function () {
+				echo '<div class="notice event-espresso-admin-notice notice-warning"><p>'
+					 . sprintf(
+						 esc_html__(
+							 'Please note: The next update of Event Espresso 4 will %1$srequire%2$s PHP 5.4.45 or greater.  Your web server\'s PHP version is %3$s.  You can contact your host and ask them to update your PHP version to at least PHP 5.6.  Please do not update to the new version of Event Espresso 4 until the PHP update is completed. Read about why keeping your server on the latest version of PHP is a good idea %4$shere%5$s',
+							 'event_espresso'
+						 ),
+						 '<strong>',
+						 '</strong>',
+						 PHP_VERSION,
+						 '<a href="https://wordpress.org/support/upgrade-php/">',
+						 '</a>'
+					 )
+					 . '</p></div>';
+			});
+		}
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -36,7 +36,7 @@ 
         //$this->_response->add_output( "\n\t IN >>  " . __CLASS__ );
         //$this->_response->set_notice( 1, 'hey look at this' );
         // check required WP version
-        if (! $this->_minimum_wp_version_required()) {
+        if ( ! $this->_minimum_wp_version_required()) {
             $this->_request->un_set('activate', true);
             add_action('admin_notices', array($this, 'minimum_wp_version_error'), 1);
             //$this->_response->add_output( "\n<br />" . 'minimum_wp_version_error' );
@@ -44,12 +44,12 @@ 
             $this->_response->deactivate_plugin();
         }
         // check recommended PHP version
-        if (! $this->_minimum_php_version_recommended()) {
+        if ( ! $this->_minimum_php_version_recommended()) {
             $this->_display_minimum_recommended_php_version_notice();
         }
 
         //upcoming required version
-        if (! $this->upcomingRequiredPhpVersion()) {
+        if ( ! $this->upcomingRequiredPhpVersion()) {
             $this->displayUpcomingRequiredVersion();
         }
         $this->_response = $this->process_request_stack($this->_request, $this->_response);
@@ -172,9 +172,9 @@ 
      */
     private function _display_minimum_recommended_php_version_notice()
     {
-        if($this->_request->isAdmin()){
+        if ($this->_request->isAdmin()) {
             new PersistentAdminNotice(
-                'php_version_' . str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED) . '_recommended',
+                'php_version_'.str_replace('.', '-', EE_MIN_PHP_VER_RECOMMENDED).'_recommended',
                 sprintf(
                     __(
                         'Event Espresso recommends PHP version %1$s or greater for optimal performance. You are currently running version %2$s.%3$sIn order to update your version of PHP, you will need to contact your current hosting provider.%3$sFor information on stable PHP versions, please go to %4$s.',
@@ -199,7 +199,7 @@ 
             && apply_filters('FHEE__EE_Recommended_Versions__displayUpcomingRequiredVersion', true, $this->_request)
             && current_user_can('update_plugins')
         ) {
-            add_action('admin_notices', function () {
+            add_action('admin_notices', function() {
                 echo '<div class="notice event-espresso-admin-notice notice-warning"><p>'
                      . sprintf(
                          esc_html__(

admin_pages/events/Events_Admin_List_Table.class.php

Indentation +526 added lines, -526 removed lines

@@ -18,530 +18,530 @@
 class Events_Admin_List_Table extends EE_Admin_List_Table
 {
 
-    /**
-     * @var EE_Datetime
-     */
-    private $_dtt;
-
-
-
-    /**
-     * Initial setup of data properties for the list table.
-     */
-    protected function _setup_data()
-    {
-        $this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
-        $this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
-    }
-
-
-
-    /**
-     * Set up of additional properties for the list table.
-     */
-    protected function _set_properties()
-    {
-        $this->_wp_list_args = array(
-            'singular' => esc_html__('event', 'event_espresso'),
-            'plural'   => esc_html__('events', 'event_espresso'),
-            'ajax'     => true, //for now
-            'screen'   => $this->_admin_page->get_current_screen()->id,
-        );
-        $this->_columns = array(
-            'cb'              => '<input type="checkbox" />',
-            'id'              => esc_html__('ID', 'event_espresso'),
-            'name'            => esc_html__('Name', 'event_espresso'),
-            'author'          => esc_html__('Author', 'event_espresso'),
-            'venue'           => esc_html__('Venue', 'event_espresso'),
-            'start_date_time' => esc_html__('Event Start', 'event_espresso'),
-            'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
-            'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
-                                 . '<span class="screen-reader-text">'
-                                 . esc_html__('Approved Registrations', 'event_espresso')
-                                 . '</span>'
-                                 . '</span>',
-            //'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
-            'actions'         => esc_html__('Actions', 'event_espresso'),
-        );
-        $this->_sortable_columns = array(
-            'id'              => array('EVT_ID' => true),
-            'name'            => array('EVT_name' => false),
-            'author'          => array('EVT_wp_user' => false),
-            'venue'           => array('Venue.VNU_name' => false),
-            'start_date_time' => array('Datetime.DTT_EVT_start' => false),
-            'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
-        );
-        $this->_primary_column = 'id';
-        $this->_hidden_columns = array('author');
-    }
-
-
-
-    /**
-     * @return array
-     */
-    protected function _get_table_filters()
-    {
-        return array(); //no filters with decaf
-    }
-
-
-
-    /**
-     * Setup of views properties.
-     *
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws InvalidArgumentException
-     */
-    protected function _add_view_counts()
-    {
-        $this->_views['all']['count'] = $this->_admin_page->total_events();
-        $this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_events',
-            'espresso_events_trash_events'
-        )) {
-            $this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
-        }
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    protected function _get_row_class($item)
-    {
-        $class = parent::_get_row_class($item);
-        //add status class
-        $class .= $item instanceof EE_Event
-            ? ' ee-status-strip event-status-' . $item->get_active_status()
-            : '';
-        if ($this->_has_checkbox_column) {
-            $class .= ' has-checkbox-column';
-        }
-        return $class;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_status(EE_Event $item)
-    {
-        return '<span class="ee-status-strip ee-status-strip-td event-status-'
-               . $item->get_active_status()
-               . '"></span>';
-    }
-
-
-
-    /**
-     * @param  EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_cb($item)
-    {
-        if (! $item instanceof EE_Event) {
-            return '';
-        }
-        $this->_dtt = $item->primary_datetime(); //set this for use in other columns
-        //does event have any attached registrations?
-        $regs = $item->count_related('Registration');
-        return $regs > 0 && $this->_view === 'trash'
-            ? '<span class="ee-lock-icon"></span>'
-            : sprintf(
-                '<input type="checkbox" name="EVT_IDs[]" value="%s" />',
-                $item->ID()
-            );
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return mixed|string
-     * @throws EE_Error
-     */
-    public function column_id(EE_Event $item)
-    {
-        $content = $item->ID();
-        $content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
-        return $content;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_name(EE_Event $item)
-    {
-        $edit_query_args = array(
-            'action' => 'edit',
-            'post'   => $item->ID(),
-        );
-        $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-        $actions = $this->_column_name_action_setup($item);
-        $status = ''; //$item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
-        $content = '<strong><a class="row-title" href="'
-                   . $edit_link . '">'
-                   . $item->name()
-                   . '</a></strong>'
-                   . $status;
-        $content .= '<br><span class="ee-status-text-small">'
-                    . EEH_Template::pretty_status(
-                $item->get_active_status(),
-                false,
-                'sentence'
-            )
-                    . '</span>';
-        $content .= $this->row_actions($actions);
-        return $content;
-    }
-
-
-
-    /**
-     * Just a method for setting up the actions for the name column
-     *
-     * @param EE_Event $item
-     * @return array array of actions
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    protected function _column_name_action_setup(EE_Event $item)
-    {
-        //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $actions = array();
-        $restore_event_link = '';
-        $delete_event_link = '';
-        $trash_event_link = '';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $actions['edit'] = '<a href="' . $edit_link . '"'
-                               . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                               . esc_html__('Edit', 'event_espresso')
-                               . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            )
-            && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $actions['attendees'] = '<a href="' . $attendees_link . '"'
-                                    . ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
-                                    . esc_html__('Registrations', 'event_espresso')
-                                    . '</a>';
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_trash_event',
-            $item->ID()
-        )
-        ) {
-            $trash_event_query_args = array(
-                'action' => 'trash_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $trash_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_restore_event',
-            $item->ID()
-        )
-        ) {
-            $restore_event_query_args = array(
-                'action' => 'restore_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $restore_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        if (
-        EE_Registry::instance()->CAP->current_user_can(
-            'ee_delete_event',
-            'espresso_events_delete_event',
-            $item->ID()
-        )
-        ) {
-            $delete_event_query_args = array(
-                'action' => 'delete_event',
-                'EVT_ID' => $item->ID(),
-            );
-            $delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
-                $delete_event_query_args,
-                EVENTS_ADMIN_URL
-            );
-        }
-        $view_link = get_permalink($item->ID());
-        $actions['view'] = '<a href="' . $view_link . '"'
-                           . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
-                           . esc_html__('View', 'event_espresso')
-                           . '</a>';
-        if ($item->get('status') === 'trash') {
-            if (EE_Registry::instance()->CAP->current_user_can(
-                'ee_delete_event',
-                'espresso_events_restore_event',
-                $item->ID()
-            )) {
-                $actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
-                                                 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
-                                                 . '">'
-                                                 . esc_html__('Restore from Trash', 'event_espresso')
-                                                 . '</a>';
-            }
-            if (
-                $item->count_related('Registration') === 0
-                && EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_delete_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['delete'] = '<a href="' . $delete_event_link . '"'
-                                     . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
-                                     . esc_html__('Delete Permanently', 'event_espresso')
-                                     . '</a>';
-            }
-        } else {
-            if (
-                EE_Registry::instance()->CAP->current_user_can(
-                    'ee_delete_event',
-                    'espresso_events_trash_event',
-                    $item->ID()
-                )
-            ) {
-                $actions['move to trash'] = '<a href="' . $trash_event_link . '"'
-                                            . ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
-                                            . esc_html__('Trash', 'event_espresso')
-                                            . '</a>';
-            }
-        }
-        return $actions;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_author(EE_Event $item)
-    {
-        //user author info
-        $event_author = get_userdata($item->wp_user());
-        $gravatar = get_avatar($item->wp_user(), '15');
-        //filter link
-        $query_args = array(
-            'action'      => 'default',
-            'EVT_wp_user' => $item->wp_user(),
-        );
-        $filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
-        return $gravatar . '  <a href="' . $filter_url . '"'
-               . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
-               . $event_author->display_name
-               . '</a>';
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_venue(EE_Event $item)
-    {
-        $venue = $item->get_first_related('Venue');
-        return ! empty($venue)
-            ? $venue->name()
-            : '';
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_start_date_time(EE_Event $item)
-    {
-        return $this->_dtt instanceof EE_Datetime
-            ? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
-            : esc_html__('No Date was saved for this Event', 'event_espresso');
-    }
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     */
-    public function column_reg_begins(EE_Event $item)
-    {
-        $reg_start = $item->get_ticket_with_earliest_start_time();
-        return $reg_start instanceof EE_Ticket
-            ? $reg_start->get_i18n_datetime('TKT_start_date')
-            : esc_html__('No Tickets have been setup for this Event', 'event_espresso');
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return int|string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_attendees(EE_Event $item)
-    {
-        $attendees_query_args = array(
-            'action'   => 'default',
-            'event_id' => $item->ID(),
-        );
-        $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-        $registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
-        return EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_event',
-            'espresso_registrations_view_registration',
-            $item->ID()
-        )
-               && EE_Registry::instance()->CAP->current_user_can(
-            'ee_read_registrations',
-            'espresso_registrations_view_registration'
-        )
-            ? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
-            : $registered_attendees;
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return float
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_tkts_sold(EE_Event $item)
-    {
-        return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
-    }
-
-
-
-    /**
-     * @param EE_Event $item
-     * @return string
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function column_actions(EE_Event $item)
-    {
-        //todo: remove when attendees is active
-        if (! defined('REG_ADMIN_URL')) {
-            define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
-        }
-        $action_links = array();
-        $view_link = get_permalink($item->ID());
-        $action_links[] = '<a href="' . $view_link . '"'
-                         . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
-        $action_links[] = '<div class="dashicons dashicons-search"></div></a>';
-        if (EE_Registry::instance()->CAP->current_user_can(
-            'ee_edit_event',
-            'espresso_events_edit',
-            $item->ID()
-        )) {
-            $edit_query_args = array(
-                'action' => 'edit',
-                'post'   => $item->ID(),
-            );
-            $edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
-            $action_links[] = '<a href="' . $edit_link . '"'
-                             . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
-                             . '<div class="ee-icon ee-icon-calendar-edit"></div>'
-                             . '</a>';
-        }
-        if (
-            EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_registrations',
-                'espresso_registrations_view_registration'
-            ) && EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_event',
-                'espresso_registrations_view_registration',
-                $item->ID()
-            )
-        ) {
-            $attendees_query_args = array(
-                'action'   => 'default',
-                'event_id' => $item->ID(),
-            );
-            $attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
-            $action_links[] = '<a href="' . $attendees_link . '"'
-                             . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
-                             . '<div class="dashicons dashicons-groups"></div>'
-                             . '</a>';
-        }
-        $action_links = apply_filters(
-            'FHEE__Events_Admin_List_Table__column_actions__action_links',
-            $action_links,
-            $item
-        );
-        return $this->_action_string(
-            implode("\n\t", $action_links),
-            $item,
-            'div'
-        );
-    }
+	/**
+	 * @var EE_Datetime
+	 */
+	private $_dtt;
+
+
+
+	/**
+	 * Initial setup of data properties for the list table.
+	 */
+	protected function _setup_data()
+	{
+		$this->_data = $this->_admin_page->get_events($this->_per_page, $this->_current_page);
+		$this->_all_data_count = $this->_admin_page->get_events(0, 0, true);
+	}
+
+
+
+	/**
+	 * Set up of additional properties for the list table.
+	 */
+	protected function _set_properties()
+	{
+		$this->_wp_list_args = array(
+			'singular' => esc_html__('event', 'event_espresso'),
+			'plural'   => esc_html__('events', 'event_espresso'),
+			'ajax'     => true, //for now
+			'screen'   => $this->_admin_page->get_current_screen()->id,
+		);
+		$this->_columns = array(
+			'cb'              => '<input type="checkbox" />',
+			'id'              => esc_html__('ID', 'event_espresso'),
+			'name'            => esc_html__('Name', 'event_espresso'),
+			'author'          => esc_html__('Author', 'event_espresso'),
+			'venue'           => esc_html__('Venue', 'event_espresso'),
+			'start_date_time' => esc_html__('Event Start', 'event_espresso'),
+			'reg_begins'      => esc_html__('On Sale', 'event_espresso'),
+			'attendees'       => '<span class="dashicons dashicons-groups ee-icon-color-ee-green ee-icon-size-20">'
+								 . '<span class="screen-reader-text">'
+								 . esc_html__('Approved Registrations', 'event_espresso')
+								 . '</span>'
+								 . '</span>',
+			//'tkts_sold' => esc_html__('Tickets Sold', 'event_espresso'),
+			'actions'         => esc_html__('Actions', 'event_espresso'),
+		);
+		$this->_sortable_columns = array(
+			'id'              => array('EVT_ID' => true),
+			'name'            => array('EVT_name' => false),
+			'author'          => array('EVT_wp_user' => false),
+			'venue'           => array('Venue.VNU_name' => false),
+			'start_date_time' => array('Datetime.DTT_EVT_start' => false),
+			'reg_begins'      => array('Datetime.Ticket.TKT_start_date' => false),
+		);
+		$this->_primary_column = 'id';
+		$this->_hidden_columns = array('author');
+	}
+
+
+
+	/**
+	 * @return array
+	 */
+	protected function _get_table_filters()
+	{
+		return array(); //no filters with decaf
+	}
+
+
+
+	/**
+	 * Setup of views properties.
+	 *
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws InvalidArgumentException
+	 */
+	protected function _add_view_counts()
+	{
+		$this->_views['all']['count'] = $this->_admin_page->total_events();
+		$this->_views['draft']['count'] = $this->_admin_page->total_events_draft();
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_events',
+			'espresso_events_trash_events'
+		)) {
+			$this->_views['trash']['count'] = $this->_admin_page->total_trashed_events();
+		}
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	protected function _get_row_class($item)
+	{
+		$class = parent::_get_row_class($item);
+		//add status class
+		$class .= $item instanceof EE_Event
+			? ' ee-status-strip event-status-' . $item->get_active_status()
+			: '';
+		if ($this->_has_checkbox_column) {
+			$class .= ' has-checkbox-column';
+		}
+		return $class;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_status(EE_Event $item)
+	{
+		return '<span class="ee-status-strip ee-status-strip-td event-status-'
+			   . $item->get_active_status()
+			   . '"></span>';
+	}
+
+
+
+	/**
+	 * @param  EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_cb($item)
+	{
+		if (! $item instanceof EE_Event) {
+			return '';
+		}
+		$this->_dtt = $item->primary_datetime(); //set this for use in other columns
+		//does event have any attached registrations?
+		$regs = $item->count_related('Registration');
+		return $regs > 0 && $this->_view === 'trash'
+			? '<span class="ee-lock-icon"></span>'
+			: sprintf(
+				'<input type="checkbox" name="EVT_IDs[]" value="%s" />',
+				$item->ID()
+			);
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return mixed|string
+	 * @throws EE_Error
+	 */
+	public function column_id(EE_Event $item)
+	{
+		$content = $item->ID();
+		$content .= '  <span class="show-on-mobile-view-only">' . $item->name() . '</span>';
+		return $content;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_name(EE_Event $item)
+	{
+		$edit_query_args = array(
+			'action' => 'edit',
+			'post'   => $item->ID(),
+		);
+		$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+		$actions = $this->_column_name_action_setup($item);
+		$status = ''; //$item->status() !== 'publish' ? ' (' . $item->status() . ')' : '';
+		$content = '<strong><a class="row-title" href="'
+				   . $edit_link . '">'
+				   . $item->name()
+				   . '</a></strong>'
+				   . $status;
+		$content .= '<br><span class="ee-status-text-small">'
+					. EEH_Template::pretty_status(
+				$item->get_active_status(),
+				false,
+				'sentence'
+			)
+					. '</span>';
+		$content .= $this->row_actions($actions);
+		return $content;
+	}
+
+
+
+	/**
+	 * Just a method for setting up the actions for the name column
+	 *
+	 * @param EE_Event $item
+	 * @return array array of actions
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	protected function _column_name_action_setup(EE_Event $item)
+	{
+		//todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$actions = array();
+		$restore_event_link = '';
+		$delete_event_link = '';
+		$trash_event_link = '';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$actions['edit'] = '<a href="' . $edit_link . '"'
+							   . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							   . esc_html__('Edit', 'event_espresso')
+							   . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			)
+			&& EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$actions['attendees'] = '<a href="' . $attendees_link . '"'
+									. ' title="' . esc_attr__('View Registrations', 'event_espresso') . '">'
+									. esc_html__('Registrations', 'event_espresso')
+									. '</a>';
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_trash_event',
+			$item->ID()
+		)
+		) {
+			$trash_event_query_args = array(
+				'action' => 'trash_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$trash_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$trash_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_restore_event',
+			$item->ID()
+		)
+		) {
+			$restore_event_query_args = array(
+				'action' => 'restore_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$restore_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$restore_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		if (
+		EE_Registry::instance()->CAP->current_user_can(
+			'ee_delete_event',
+			'espresso_events_delete_event',
+			$item->ID()
+		)
+		) {
+			$delete_event_query_args = array(
+				'action' => 'delete_event',
+				'EVT_ID' => $item->ID(),
+			);
+			$delete_event_link = EE_Admin_Page::add_query_args_and_nonce(
+				$delete_event_query_args,
+				EVENTS_ADMIN_URL
+			);
+		}
+		$view_link = get_permalink($item->ID());
+		$actions['view'] = '<a href="' . $view_link . '"'
+						   . ' title="' . esc_attr__('View Event', 'event_espresso') . '">'
+						   . esc_html__('View', 'event_espresso')
+						   . '</a>';
+		if ($item->get('status') === 'trash') {
+			if (EE_Registry::instance()->CAP->current_user_can(
+				'ee_delete_event',
+				'espresso_events_restore_event',
+				$item->ID()
+			)) {
+				$actions['restore_from_trash'] = '<a href="' . $restore_event_link . '"'
+												 . ' title="' . esc_attr__('Restore from Trash', 'event_espresso')
+												 . '">'
+												 . esc_html__('Restore from Trash', 'event_espresso')
+												 . '</a>';
+			}
+			if (
+				$item->count_related('Registration') === 0
+				&& EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_delete_event',
+					$item->ID()
+				)
+			) {
+				$actions['delete'] = '<a href="' . $delete_event_link . '"'
+									 . ' title="' . esc_attr__('Delete Permanently', 'event_espresso') . '">'
+									 . esc_html__('Delete Permanently', 'event_espresso')
+									 . '</a>';
+			}
+		} else {
+			if (
+				EE_Registry::instance()->CAP->current_user_can(
+					'ee_delete_event',
+					'espresso_events_trash_event',
+					$item->ID()
+				)
+			) {
+				$actions['move to trash'] = '<a href="' . $trash_event_link . '"'
+											. ' title="' . esc_attr__('Trash Event', 'event_espresso') . '">'
+											. esc_html__('Trash', 'event_espresso')
+											. '</a>';
+			}
+		}
+		return $actions;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_author(EE_Event $item)
+	{
+		//user author info
+		$event_author = get_userdata($item->wp_user());
+		$gravatar = get_avatar($item->wp_user(), '15');
+		//filter link
+		$query_args = array(
+			'action'      => 'default',
+			'EVT_wp_user' => $item->wp_user(),
+		);
+		$filter_url = EE_Admin_Page::add_query_args_and_nonce($query_args, EVENTS_ADMIN_URL);
+		return $gravatar . '  <a href="' . $filter_url . '"'
+			   . ' title="' . esc_attr__('Click to filter events by this author.', 'event_espresso') . '">'
+			   . $event_author->display_name
+			   . '</a>';
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_venue(EE_Event $item)
+	{
+		$venue = $item->get_first_related('Venue');
+		return ! empty($venue)
+			? $venue->name()
+			: '';
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_start_date_time(EE_Event $item)
+	{
+		return $this->_dtt instanceof EE_Datetime
+			? $this->_dtt->get_i18n_datetime('DTT_EVT_start')
+			: esc_html__('No Date was saved for this Event', 'event_espresso');
+	}
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function column_reg_begins(EE_Event $item)
+	{
+		$reg_start = $item->get_ticket_with_earliest_start_time();
+		return $reg_start instanceof EE_Ticket
+			? $reg_start->get_i18n_datetime('TKT_start_date')
+			: esc_html__('No Tickets have been setup for this Event', 'event_espresso');
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return int|string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_attendees(EE_Event $item)
+	{
+		$attendees_query_args = array(
+			'action'   => 'default',
+			'event_id' => $item->ID(),
+		);
+		$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+		$registered_attendees = EEM_Registration::instance()->get_event_registration_count($item->ID());
+		return EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_event',
+			'espresso_registrations_view_registration',
+			$item->ID()
+		)
+			   && EE_Registry::instance()->CAP->current_user_can(
+			'ee_read_registrations',
+			'espresso_registrations_view_registration'
+		)
+			? '<a href="' . $attendees_link . '">' . $registered_attendees . '</a>'
+			: $registered_attendees;
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return float
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_tkts_sold(EE_Event $item)
+	{
+		return EEM_Ticket::instance()->sum(array(array('Datetime.EVT_ID' => $item->ID())), 'TKT_sold');
+	}
+
+
+
+	/**
+	 * @param EE_Event $item
+	 * @return string
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function column_actions(EE_Event $item)
+	{
+		//todo: remove when attendees is active
+		if (! defined('REG_ADMIN_URL')) {
+			define('REG_ADMIN_URL', EVENTS_ADMIN_URL);
+		}
+		$action_links = array();
+		$view_link = get_permalink($item->ID());
+		$action_links[] = '<a href="' . $view_link . '"'
+						 . ' title="' . esc_attr__('View Event', 'event_espresso') . '" target="_blank">';
+		$action_links[] = '<div class="dashicons dashicons-search"></div></a>';
+		if (EE_Registry::instance()->CAP->current_user_can(
+			'ee_edit_event',
+			'espresso_events_edit',
+			$item->ID()
+		)) {
+			$edit_query_args = array(
+				'action' => 'edit',
+				'post'   => $item->ID(),
+			);
+			$edit_link = EE_Admin_Page::add_query_args_and_nonce($edit_query_args, EVENTS_ADMIN_URL);
+			$action_links[] = '<a href="' . $edit_link . '"'
+							 . ' title="' . esc_attr__('Edit Event', 'event_espresso') . '">'
+							 . '<div class="ee-icon ee-icon-calendar-edit"></div>'
+							 . '</a>';
+		}
+		if (
+			EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_registrations',
+				'espresso_registrations_view_registration'
+			) && EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_event',
+				'espresso_registrations_view_registration',
+				$item->ID()
+			)
+		) {
+			$attendees_query_args = array(
+				'action'   => 'default',
+				'event_id' => $item->ID(),
+			);
+			$attendees_link = EE_Admin_Page::add_query_args_and_nonce($attendees_query_args, REG_ADMIN_URL);
+			$action_links[] = '<a href="' . $attendees_link . '"'
+							 . ' title="' . esc_attr__('View Registrants', 'event_espresso') . '">'
+							 . '<div class="dashicons dashicons-groups"></div>'
+							 . '</a>';
+		}
+		$action_links = apply_filters(
+			'FHEE__Events_Admin_List_Table__column_actions__action_links',
+			$action_links,
+			$item
+		);
+		return $this->_action_string(
+			implode("\n\t", $action_links),
+			$item,
+			'div'
+		);
+	}
 }