eventespresso / event-espresso-core

core/db_models/fields/EE_Primary_Key_String_Field.php

Indentation +19 added lines, -19 removed lines

@@ -2,25 +2,25 @@
 
 class EE_Primary_Key_String_Field extends EE_Primary_Key_Field_Base
 {
-    public function __construct($table_column, $nicename)
-    {
-        parent::__construct($table_column, $nicename, null);
-    }
+	public function __construct($table_column, $nicename)
+	{
+		parent::__construct($table_column, $nicename, null);
+	}
 
 
-    /**
-     * removes all tags when setting
-     *
-     * @param EE_Base_Class|string|null $value_inputted_for_field_on_model_object
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return wp_strip_all_tags((string) $value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param EE_Base_Class|string|null $value_inputted_for_field_on_model_object
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return wp_strip_all_tags((string) $value_inputted_for_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Enum_Integer_Field.php

Indentation +94 added lines, -94 removed lines

@@ -11,108 +11,108 @@
  */
 class EE_Enum_Integer_Field extends EE_Integer_Field
 {
-    public array $_allowed_enum_values;
+	public array $_allowed_enum_values;
 
 
-    /**
-     * @param string  $table_column
-     * @param string  $nicename
-     * @param boolean $nullable
-     * @param int     $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, array $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = $allowed_enum_values;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::OBJECT);
-    }
+	/**
+	 * @param string  $table_column
+	 * @param string  $nicename
+	 * @param boolean $nullable
+	 * @param int     $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, array $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = $allowed_enum_values;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::OBJECT);
+	}
 
 
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EE_Enum_Integer_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
 
 
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
-     *
-     * @param int $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $allowed_enum_values = $this->_allowed_enum_values();
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg  = sprintf(
-                    esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($allowed_enum_values)),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return (int) $value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default)
+	 *
+	 * @param int $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$allowed_enum_values = $this->_allowed_enum_values();
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $allowed_enum_values)
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg  = sprintf(
+					esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					esc_html__('Allowed values for "%1$s" are "%2$s". You provided "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($allowed_enum_values)),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return (int) $value_inputted_for_field_on_model_object;
+	}
 
 
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param int | string $value_on_field_to_be_outputted
-     * @param string|null  $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
-    }
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param int | string $value_on_field_to_be_outputted
+	 * @param string|null  $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
+	}
 
 
-    public function getSchemaProperties(): array
-    {
-        return [
-            'raw'    => [
-                'description' => sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum'        => array_keys($this->_allowed_enum_values()),
-                'type'        => SchemaType::INTEGER,
-            ],
-            'pretty' => [
-                'description' => sprintf(
-                    esc_html__('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'enum'        => array_values($this->_allowed_enum_values()),
-                'type'        => SchemaType::STRING,
-                'read_only'   => true,
-            ],
-        ];
-    }
+	public function getSchemaProperties(): array
+	{
+		return [
+			'raw'    => [
+				'description' => sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum'        => array_keys($this->_allowed_enum_values()),
+				'type'        => SchemaType::INTEGER,
+			],
+			'pretty' => [
+				'description' => sprintf(
+					esc_html__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'enum'        => array_values($this->_allowed_enum_values()),
+				'type'        => SchemaType::STRING,
+				'read_only'   => true,
+			],
+		];
+	}
 }

core/db_models/fields/EE_JSON_Field.php

Indentation +62 added lines, -62 removed lines

@@ -5,74 +5,74 @@
 
 class EE_JSON_Field extends EE_Model_Field_Base
 {
-    private JsonDataHandler $json_data_handler;
+	private JsonDataHandler $json_data_handler;
 
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct(
-        $table_column,
-        $nicename,
-        $nullable,
-        $default_value = null
-    ) {
-        $this->json_data_handler = new JsonDataHandler();
-        $this->json_data_handler->configure(
-            JsonDataHandler::DATA_TYPE_OBJECT
-        );
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::STRING);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct(
+		$table_column,
+		$nicename,
+		$nullable,
+		$default_value = null
+	) {
+		$this->json_data_handler = new JsonDataHandler();
+		$this->json_data_handler->configure(
+			JsonDataHandler::DATA_TYPE_OBJECT
+		);
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::STRING);
+	}
 
 
-    // /**
-    //  * When get() is called on a model object (eg EE_Event), before returning its value,
-    //  * call this function on it, allowing us to customize the returned value based on
-    //  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
-    //  * we simply return it.
-    //  *
-    //  * @param mixed $value_of_field_on_model_object
-    //  * @return mixed
-    //  */
-    // public function prepare_for_get($value_of_field_on_model_object)
-    // {
-    //     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
-    //     return $value_of_field_on_model_object;
-    // }
+	// /**
+	//  * When get() is called on a model object (eg EE_Event), before returning its value,
+	//  * call this function on it, allowing us to customize the returned value based on
+	//  * the field's type. Eg, we may want to unserialize it, strip tags, etc. By default,
+	//  * we simply return it.
+	//  *
+	//  * @param mixed $value_of_field_on_model_object
+	//  * @return mixed
+	//  */
+	// public function prepare_for_get($value_of_field_on_model_object)
+	// {
+	//     // return $this->json_data_handler->decodeJson($value_of_field_on_model_object);
+	//     return $value_of_field_on_model_object;
+	// }
 
 
-    /**
-     * When creating a brand-new model object, or setting a particular value for one of its fields, this function
-     * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
-     * By default, we do nothing.
-     *
-     * If the model field is going to perform any validation on the input, this is where it should be done
-     * (once the value is on the model object, it may be used in other ways besides putting it into the DB
-     * so it's best to validate it right away).
-     *
-     * @param mixed $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * When creating a brand-new model object, or setting a particular value for one of its fields, this function
+	 * is called before setting it on the model object. We may want to strip slashes, unserialize the value, etc.
+	 * By default, we do nothing.
+	 *
+	 * If the model field is going to perform any validation on the input, this is where it should be done
+	 * (once the value is on the model object, it may be used in other ways besides putting it into the DB
+	 * so it's best to validate it right away).
+	 *
+	 * @param mixed $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_inputted_for_field_on_model_object);
+	}
 
 
-    /**
-     * When inserting or updating a field on a model object, run this function on each
-     * value to prepare it for insertion into the db. Generally this converts
-     * the validated input on the model object into the format used in the DB.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return $this->json_data_handler->encodeData($value_of_field_on_model_object);
-    }
+	/**
+	 * When inserting or updating a field on a model object, run this function on each
+	 * value to prepare it for insertion into the db. Generally this converts
+	 * the validated input on the model object into the format used in the DB.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return $this->json_data_handler->encodeData($value_of_field_on_model_object);
+	}
 }

core/db_models/fields/EE_Full_HTML_Field.php

Indentation +48 added lines, -48 removed lines

@@ -15,56 +15,56 @@
  */
 class EE_Full_HTML_Field extends EE_Text_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::STRING);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::STRING);
+	}
 
 
-    /**
-     * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
-     *
-     * @param mixed       $value_on_field_to_be_outputted
-     * @param string|null $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        if ($schema == 'form_input') {
-            return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-        } elseif ($schema == 'no_wpautop') {
-            return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
-        } else {
-            return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
-        }
-    }
+	/**
+	 * Does shortcodes and auto-paragraphs the content (unless schema is 'no_wpautop')
+	 *
+	 * @param mixed       $value_on_field_to_be_outputted
+	 * @param string|null $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		if ($schema == 'form_input') {
+			return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+		} elseif ($schema == 'no_wpautop') {
+			return do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema));
+		} else {
+			return wpautop(do_shortcode(parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema)));
+		}
+	}
 
 
-    public function getSchemaProperties(): array
-    {
-        return [
-            'raw'      => [
-                'description' => sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-            ],
-            'rendered' => [
-                'description' => sprintf(
-                    esc_html__('%s - transformed for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-                'readonly'    => true,
-            ],
-        ];
-    }
+	public function getSchemaProperties(): array
+	{
+		return [
+			'raw'      => [
+				'description' => sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+			],
+			'rendered' => [
+				'description' => sprintf(
+					esc_html__('%s - transformed for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+				'readonly'    => true,
+			],
+		];
+	}
 }

core/db_models/fields/EE_DB_Only_Field_Base.php

Indentation +23 added lines, -23 removed lines

@@ -11,29 +11,29 @@
  */
 abstract class EE_DB_Only_Field_Base extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::STRING);
-        $this->setSchemaReadOnly(true);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::STRING);
+		$this->setSchemaReadOnly(true);
+	}
 
 
-    /**
-     * All these children classes are for the db-only (meaning, we should select them
-     * on get_all queries, update, delete, and will still want to set their default value
-     * on inserts, but the model object won't have reference to these fields)
-     *
-     * @return boolean
-     */
-    public function is_db_only_field(): bool
-    {
-        return true;
-    }
+	/**
+	 * All these children classes are for the db-only (meaning, we should select them
+	 * on get_all queries, update, delete, and will still want to set their default value
+	 * on inserts, but the model object won't have reference to these fields)
+	 *
+	 * @return boolean
+	 */
+	public function is_db_only_field(): bool
+	{
+		return true;
+	}
 }

core/db_models/fields/EE_Foreign_Key_String_Field.php

Indentation +34 added lines, -34 removed lines

@@ -2,41 +2,41 @@
 
 class EE_Foreign_Key_String_Field extends EE_Foreign_Key_Field_Base
 {
-    /**
-     * Whether the value should be converted to uppercase on insertion.
-     *
-     * @var bool
-     */
-    protected bool $is_uppercase;
+	/**
+	 * Whether the value should be converted to uppercase on insertion.
+	 *
+	 * @var bool
+	 */
+	protected bool $is_uppercase;
 
 
-    /**
-     * @param string          $table_column  name of column for field
-     * @param string          $nicename      should be internationalized with __('blah','event_espresso')
-     * @param boolean         $nullable
-     * @param int|string      $default_value data type should match field type
-     * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
-     *                                       Basically its the model class's name without the "EEM_"
-     * @param boolean         $is_uppercase  Whether the value should be converted to uppercase on insertion.
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name, bool $is_uppercase = true)
-    {
-        $this->is_uppercase = $is_uppercase;
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-    }
+	/**
+	 * @param string          $table_column  name of column for field
+	 * @param string          $nicename      should be internationalized with __('blah','event_espresso')
+	 * @param boolean         $nullable
+	 * @param int|string      $default_value data type should match field type
+	 * @param string|string[] $model_name    eg 'Event','Answer','Term', etc.
+	 *                                       Basically its the model class's name without the "EEM_"
+	 * @param boolean         $is_uppercase  Whether the value should be converted to uppercase on insertion.
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name, bool $is_uppercase = true)
+	{
+		$this->is_uppercase = $is_uppercase;
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+	}
 
-    /**
-     * removes all tags when setting
-     *
-     * @param string|null $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        $clean_value = wp_strip_all_tags((string) $value_inputted_for_field_on_model_object);
-        return $this->is_uppercase ? strtoupper($clean_value) : $clean_value;
-    }
+	/**
+	 * removes all tags when setting
+	 *
+	 * @param string|null $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		$clean_value = wp_strip_all_tags((string) $value_inputted_for_field_on_model_object);
+		return $this->is_uppercase ? strtoupper($clean_value) : $clean_value;
+	}
 }

core/db_models/fields/EE_WP_User_Field.php

Indentation +33 added lines, -33 removed lines

@@ -12,38 +12,38 @@
  */
 class EE_WP_User_Field extends EE_Foreign_Key_Int_Field
 {
-    /**
-     * No need to provide a default or the model pointed to- the default is
-     * always get_current_user_id() and the model pointed to is always WP_User
-     *
-     * @param string  $table_column name fo column for field
-     * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     */
-    public function __construct($table_column, $nicename, $nullable)
-    {
-        parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
-    }
+	/**
+	 * No need to provide a default or the model pointed to- the default is
+	 * always get_current_user_id() and the model pointed to is always WP_User
+	 *
+	 * @param string  $table_column name fo column for field
+	 * @param string  $nicename     should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 */
+	public function __construct($table_column, $nicename, $nullable)
+	{
+		parent::__construct($table_column, $nicename, $nullable, null, 'WP_User');
+	}
 
-    /**
-     * Gets the default which is always the current user. This can't be set when initially
-     * constructing the model field because that's done before $current_user is set
-     *
-     * @return int
-     */
-    public function get_default_value()
-    {
-        if (did_action('init')) {
-            return get_current_user_id();
-        }
-        EE_Error::doing_it_wrong(
-            'EE_WP_User_Field::get_default_value',
-            esc_html__(
-                'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
-                'event_espresso'
-            ),
-            '4.6.20'
-        );
-        return 1;
-    }
+	/**
+	 * Gets the default which is always the current user. This can't be set when initially
+	 * constructing the model field because that's done before $current_user is set
+	 *
+	 * @return int
+	 */
+	public function get_default_value()
+	{
+		if (did_action('init')) {
+			return get_current_user_id();
+		}
+		EE_Error::doing_it_wrong(
+			'EE_WP_User_Field::get_default_value',
+			esc_html__(
+				'You cant get a default value for a wp_User_Field because the "init" action is called, because current_user global hasnt yet been setup. Consider doing your business logic on the "init" hook or later.',
+				'event_espresso'
+			),
+			'4.6.20'
+		);
+		return 1;
+	}
 }

core/db_models/fields/EE_Serialized_Text_Field.php

Indentation +65 added lines, -65 removed lines

@@ -10,77 +10,77 @@
  */
 class EE_Serialized_Text_Field extends EE_Text_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType([SchemaType::OBJECT, SchemaType::STRING]);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType([SchemaType::OBJECT, SchemaType::STRING]);
+	}
 
 
-    /**
-     * Value SHOULD be an array, and we want to now convert it to a serialized string
-     *
-     * @param array $value_of_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        return maybe_serialize($value_of_field_on_model_object);
-    }
+	/**
+	 * Value SHOULD be an array, and we want to now convert it to a serialized string
+	 *
+	 * @param array $value_of_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		return maybe_serialize($value_of_field_on_model_object);
+	}
 
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $value_inputted_for_field_on_model_object =
-            EEH_Array::maybe_unserialize($value_inputted_for_field_on_model_object);
-        if (is_string($value_inputted_for_field_on_model_object)) {
-            return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-        }
-        if (is_array($value_inputted_for_field_on_model_object)) {
-            return array_map([$this, 'prepare_for_set'], $value_inputted_for_field_on_model_object);
-        }
-        // so they passed NULL or an INT or something wack
-        return $value_inputted_for_field_on_model_object;
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$value_inputted_for_field_on_model_object =
+			EEH_Array::maybe_unserialize($value_inputted_for_field_on_model_object);
+		if (is_string($value_inputted_for_field_on_model_object)) {
+			return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+		}
+		if (is_array($value_inputted_for_field_on_model_object)) {
+			return array_map([$this, 'prepare_for_set'], $value_inputted_for_field_on_model_object);
+		}
+		// so they passed NULL or an INT or something wack
+		return $value_inputted_for_field_on_model_object;
+	}
 
 
-    /**
-     * Value provided should definetely be a serialized string. We should unserialize into an array
-     *
-     * @param string $value_found_in_db_for_model_object
-     * @return array
-     */
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return EEH_Array::maybe_unserialize($value_found_in_db_for_model_object);
-    }
+	/**
+	 * Value provided should definetely be a serialized string. We should unserialize into an array
+	 *
+	 * @param string $value_found_in_db_for_model_object
+	 * @return array
+	 */
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return EEH_Array::maybe_unserialize($value_found_in_db_for_model_object);
+	}
 
 
-    /**
-     * Gets a string representation of the array
-     *
-     * @param mixed       $value_on_field_to_be_outputted
-     * @param string|null $schema , possible values are ',', others can be added
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        switch ($schema) {
-            case 'print_r':
-                $pretty_value = print_r($value_on_field_to_be_outputted, true);
-                break;
-            case 'as_table':
-                $pretty_value = EEH_Template::layout_array_as_table($value_on_field_to_be_outputted);
-                break;
-            default:
-                $pretty_value = implode(", ", $value_on_field_to_be_outputted);
-        }
-        return $pretty_value;
-    }
+	/**
+	 * Gets a string representation of the array
+	 *
+	 * @param mixed       $value_on_field_to_be_outputted
+	 * @param string|null $schema , possible values are ',', others can be added
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		switch ($schema) {
+			case 'print_r':
+				$pretty_value = print_r($value_on_field_to_be_outputted, true);
+				break;
+			case 'as_table':
+				$pretty_value = EEH_Template::layout_array_as_table($value_on_field_to_be_outputted);
+				break;
+			default:
+				$pretty_value = implode(", ", $value_on_field_to_be_outputted);
+		}
+		return $pretty_value;
+	}
 }

core/db_models/fields/EE_Datetime_Field.php

Indentation +761 added lines, -761 removed lines

@@ -19,765 +19,765 @@
  */
 class EE_Datetime_Field extends EE_Model_Field_Base
 {
-    /**
-     * The pattern we're looking for is if only the characters 0-9 are found and there are only
-     * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
-     *
-     * @type string unix_timestamp_regex
-     */
-    const unix_timestamp_regex = '/[0-9]{10,}/';
-
-    /**
-     * @type string mysql_timestamp_format
-     */
-    const mysql_timestamp_format = 'Y-m-d H:i:s';
-
-    /**
-     * @type string mysql_date_format
-     */
-    const mysql_date_format = 'Y-m-d';
-
-    /**
-     * @type string mysql_time_format
-     */
-    const mysql_time_format = 'H:i:s';
-
-    /**
-     * Const for using in the default value. If the field's default is set to this,
-     * then we will return the time of calling `get_default_value()`, not
-     * just the current time at construction
-     */
-    const now = 'now';
-
-    /**
-     * The following properties hold the default formats for date and time.
-     * Defaults are set via the constructor and can be overridden on class instantiation.
-     * However they can also be overridden later by the set_format() method
-     * (and corresponding set_date_format, set_time_format methods);
-     */
-
-    protected string        $_date_format        = '';
-
-    protected string        $_time_format        = '';
-
-    protected string        $_pretty_date_format = '';
-
-    protected string        $_pretty_time_format = '';
-
-    protected ?DateTimeZone $_DateTimeZone       = null;
-
-    protected ?DateTimeZone $_UTC_DateTimeZone   = null;
-
-    protected ?DateTimeZone $_blog_DateTimeZone  = null;
-
-
-    /**
-     * This property holds how we want the output returned when getting a datetime string.  It is set for the
-     * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
-     * and time returned via getters.
-     *
-     * @var mixed (null|string)
-     */
-    protected $_date_time_output;
-
-
-    /**
-     * timezone string
-     * This gets set by the constructor and can be changed 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.  Default timezone is the current WP timezone option setting
-     */
-    protected ?string $_timezone_string = null;
-
-
-    /**
-     * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
-     * offsets for comparison purposes).
-     *
-     * @var int
-     */
-    protected int $_blog_offset = 0;
-
-
-    /**
-     * @param string      $table_column
-     * @param string      $nice_name
-     * @param bool        $nullable
-     * @param string|null $default_value
-     * @param string|null $timezone_string
-     * @param string|null $date_format
-     * @param string|null $time_format
-     * @param string|null $pretty_date_format
-     * @param string|null $pretty_time_format
-     * @throws InvalidArgumentException
-     * @throws Exception
-     */
-    public function __construct(
-        string $table_column,
-        string $nice_name,
-        bool $nullable,
-        ?string $default_value,
-        ?string $timezone_string = '',
-        ?string $date_format = '',
-        ?string $time_format = '',
-        ?string $pretty_date_format = '',
-        ?string $pretty_time_format = ''
-    ) {
-        $this->set_date_format($date_format);
-        $this->set_time_format($time_format);
-        $this->set_date_format($pretty_date_format, true);
-        $this->set_time_format($pretty_time_format, true);
-
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->set_timezone($timezone_string);
-        $this->setSchemaType(SchemaType::STRING);
-        $this->setSchemaFormat(SchemaFormat::DATETIME);
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws Exception
-     */
-    public function get_UTC_DateTimeZone(): DateTimeZone
-    {
-        return $this->_UTC_DateTimeZone instanceof DateTimeZone
-            ? $this->_UTC_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string('UTC');
-    }
-
-
-    /**
-     * @return DateTimeZone
-     * @throws Exception
-     */
-    public function get_blog_DateTimeZone(): DateTimeZone
-    {
-        return $this->_blog_DateTimeZone instanceof DateTimeZone
-            ? $this->_blog_DateTimeZone
-            : $this->_create_timezone_object_from_timezone_string();
-    }
-
-
-    /**
-     * this prepares any incoming date data and make sure its converted to a utc unix timestamp
-     *
-     * @param string|int $value_inputted_for_field_on_model_object  could be a string formatted date time or int unix
-     *                                                              timestamp
-     * @return DateTime
-     * @throws Exception
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return $this->_get_date_object($value_inputted_for_field_on_model_object);
-    }
-
-
-    /**
-     * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
-     * getters need to know whether we're just returning the date or the time or both.  By default we return both.
-     *
-     * @param bool $pretty If we're returning the pretty formats or standard format string.
-     * @return string    The final assembled format string.
-     */
-    protected function _get_date_time_output(bool $pretty = false): string
-    {
-        switch ($this->_date_time_output) {
-            case 'time':
-                return $pretty
-                    ? $this->_pretty_time_format
-                    : $this->_time_format;
-
-            case 'date':
-                return $pretty
-                    ? $this->_pretty_date_format
-                    : $this->_date_format;
-
-            default:
-                return $pretty
-                    ? trim($this->_pretty_date_format . ' ' . $this->_pretty_time_format)
-                    : trim($this->_date_format . ' ' . $this->_time_format);
-        }
-    }
-
-
-    /**
-     * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
-     * returned (using the format properties)
-     *
-     * @param string|null $what acceptable values are 'time' or 'date'.
-     *                          Any other value will be set but will always result
-     *                          in both 'date' and 'time' being returned.
-     * @return void
-     */
-    public function set_date_time_output(?string $what = null)
-    {
-        $this->_date_time_output = $what;
-    }
-
-
-    /**
-     * 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).
-     * We also set some other properties in this method.
-     *
-     * @param string|null $timezone_string A valid timezone string as described by @link
-     *                                     http://www.php.net/manual/en/timezones.php
-     * @return void
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    public function set_timezone(?string $timezone_string = '')
-    {
-        if (empty($timezone_string) && $this->_timezone_string !== null) {
-            // leave the timezone AS-IS if we already have one and
-            // the function arg didn't provide one
-            return;
-        }
-        $timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $this->_timezone_string = ! empty($timezone_string)
-            ? $timezone_string
-            : 'UTC';
-        $this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
-    }
-
-
-    /**
-     * _create_timezone_object_from_timezone_name
-     *
-     * @access protected
-     * @param string|null $timezone_string
-     * @return DateTimeZone
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     */
-    protected function _create_timezone_object_from_timezone_string(?string $timezone_string = ''): DateTimeZone
-    {
-        return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
-    }
-
-
-    /**
-     * This just returns whatever is set for the current timezone.
-     *
-     * @access public
-     * @return string timezone string
-     */
-    public function get_timezone(): ?string
-    {
-        return $this->_timezone_string;
-    }
-
-
-    /**
-     * set the $_date_format property
-     *
-     * @access public
-     * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_date_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_date_format = new DateFormat($format);
-        } else {
-            $this->_date_format = new DateFormat($format);
-        }
-    }
-
-
-    /**
-     * return the $_date_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_date_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_date_format
-            : $this->_date_format;
-    }
-
-
-    /**
-     * set the $_time_format property
-     *
-     * @access public
-     * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
-     * @param bool   $pretty Whether to set pretty format or not.
-     * @return void
-     */
-    public function set_time_format(string $format, bool $pretty = false)
-    {
-        if ($pretty) {
-            $this->_pretty_time_format = new TimeFormat($format);
-        } else {
-            $this->_time_format = new TimeFormat($format);
-        }
-    }
-
-
-    /**
-     * return the $_time_format property value.
-     *
-     * @param bool $pretty Whether to get pretty format or not.
-     * @return string
-     */
-    public function get_time_format(bool $pretty = false): string
-    {
-        return $pretty
-            ? $this->_pretty_time_format
-            : $this->_time_format;
-    }
-
-
-    /**
-     * set the $_pretty_date_format property
-     *
-     * @access public
-     * @param string|null $format a new pretty date format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_date_format(?string $format)
-    {
-        $this->set_date_format($format, true);
-    }
-
-
-    /**
-     * set the $_pretty_time_format property
-     *
-     * @access public
-     * @param string|null $format a new pretty time format (corresponding to formats accepted by PHP date() function)
-     * @return void
-     */
-    public function set_pretty_time_format(?string $format)
-    {
-        $this->set_time_format($format, true);
-    }
-
-
-    /**
-     * Only sets the time portion of the datetime.
-     *
-     * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($time_to_set_string instanceof DateTime) {
-            $parsed = [
-                'hour'   => $time_to_set_string->format('H'),
-                'minute' => $time_to_set_string->format('i'),
-                'second' => $time_to_set_string->format('s'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
-    }
-
-
-    /**
-     * Only sets the date portion of the datetime.
-     *
-     * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
-     * @param DateTime        $current            current DateTime object for the datetime field
-     * @return DateTime
-     */
-    public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
-    {
-        // if $time_to_set_string is datetime object, then let's use it to set the parse array.
-        // Otherwise parse the string.
-        if ($date_to_set_string instanceof DateTime) {
-            $parsed = [
-                'year'  => $date_to_set_string->format('Y'),
-                'month' => $date_to_set_string->format('m'),
-                'day'   => $date_to_set_string->format('d'),
-            ];
-        } else {
-            // parse incoming string
-            $parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
-        }
-        EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
-        return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
-     * datetime gets to this stage it should ALREADY be in UTC time
-     *
-     * @param DateTime $DateTime
-     * @return string formatted date time for given timezone
-     * @throws EE_Error
-     */
-    public function prepare_for_get($DateTime): string
-    {
-        return $this->_prepare_for_display($DateTime);
-    }
-
-
-    /**
-     * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
-     * from the set wp timezone.  If so, then it returns the datetime string formatted via
-     * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
-     * abbreviation to the date_string.
-     *
-     * @param mixed       $DateTime
-     * @param string|null $schema
-     * @return string
-     * @throws EE_Error
-     */
-    public function prepare_for_pretty_echoing($DateTime, ?string $schema = null): string
-    {
-        $schema = $schema ?: true;
-        return $this->_prepare_for_display($DateTime, $schema);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param DateTime|null $DateTime
-     * @param bool|string   $schema
-     * @return string
-     * @throws EE_Error
-     * @throws Exception
-     */
-    protected function _prepare_for_display(?DateTime $DateTime, $schema = false): string
-    {
-        if (! $DateTime instanceof DateTime) {
-            if ($this->_nullable) {
-                return '';
-            }
-            if (WP_DEBUG) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
-                            'event_espresso'
-                        ),
-                        $this->_nicename
-                    )
-                );
-            }
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
-            EE_Error::add_error(
-                sprintf(
-                    esc_html__(
-                        'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
-                        'event_espresso'
-                    ),
-                    $this->_nicename
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-        }
-        $format_string = $this->_get_date_time_output($schema);
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        if ($schema) {
-            $timezone_string = '';
-            if ($this->_display_timezone()) {
-                // must be explicit because schema could equal true.
-                if ($schema === 'no_html') {
-                    $timezone_string = ' (' . $DateTime->format('T') . ')';
-                } else {
-                    $timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
-                }
-            }
-
-            return $DateTime->format($format_string) . $timezone_string;
-        }
-        return $DateTime->format($format_string);
-    }
-
-
-    /**
-     * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
-     * timezone).
-     *
-     * @param mixed $datetime_value u
-     * @return string mysql timestamp in UTC
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function prepare_for_use_in_db($datetime_value): ?string
-    {
-        // we allow an empty value or DateTime object, but nothing else.
-        if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
-            $datetime_value = $this->_get_date_object($datetime_value);
-            if (! $datetime_value instanceof DateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            'The incoming value being prepared for setting in the database for the %1$s field must either be empty or a php DateTime object, instead of: %2$s %3$s',
-                            'event_espresso'
-                        ),
-                        $this->get_name(),
-                        '<br />',
-                        print_r($datetime_value, true)
-                    )
-                );
-            }
-        }
-
-        if ($datetime_value instanceof DateTime) {
-            if (! $datetime_value instanceof DbSafeDateTime) {
-                $datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
-            }
-            EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
-            return $datetime_value->format(
-                EE_Datetime_Field::mysql_timestamp_format
-            );
-        }
-
-        // if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
-        return ! $this->_nullable
-            ? current_time('mysql', true)
-            : null;
-    }
-
-
-    /**
-     * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
-     * allowed)
-     *
-     * @param string $datetime_string mysql timestamp in UTC
-     * @return  bool|DbSafeDateTime|null
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function prepare_for_set_from_db($datetime_string)
-    {
-        // if $datetime_value is empty, and ! $this->_nullable, just use time()
-        if (empty($datetime_string) && $this->_nullable) {
-            return null;
-        }
-        // datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
-        $DateTime = empty($datetime_string)
-            ? new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone())
-            : DbSafeDateTime::createFromFormat(
-                EE_Datetime_Field::mysql_timestamp_format,
-                $datetime_string,
-                $this->get_UTC_DateTimeZone()
-            );
-
-        if (! $DateTime instanceof DbSafeDateTime) {
-            // if still no datetime object, then let's just use now
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
-        }
-        // THEN apply the field's set DateTimeZone
-        EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
-        return $DateTime;
-    }
-
-
-    /**
-     * All this method does is determine if we're going to display the timezone string or not on any output.
-     * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
-     * If so, then true.
-     *
-     * @return bool true for yes false for no
-     * @throws Exception
-     */
-    protected function _display_timezone(): bool
-    {
-        // first let's do a comparison of timezone strings.
-        // If they match then we can get out without any further calculations
-        $blog_string = get_option('timezone_string');
-        if ($blog_string === $this->_timezone_string) {
-            return false;
-        }
-        // now we need to calc the offset for the timezone string so we can compare with the blog offset.
-        $this_offset = $this->get_timezone_offset($this->_DateTimeZone);
-        $blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
-        // now compare
-        return $blog_offset !== $this_offset;
-    }
-
-
-    /**
-     * This method returns a php DateTime object for setting on the EE_Base_Class model.
-     * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
-     * with.
-     *
-     * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
-     *                                                    in the format that is set on the date_field (or DateTime
-     *                                                    object)!
-     * @return DateTime
-     * @throws Exception
-     * @throws Exception
-     */
-    protected function _get_date_object($date_string)
-    {
-        // first if this is an empty date_string and nullable is allowed, just return null.
-        if ($this->_nullable && empty($date_string)) {
-            return null;
-        }
-
-        // if incoming date
-        if ($date_string instanceof DateTime) {
-            EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
-            return $date_string;
-        }
-        // if empty date_string and made it here.
-        // Return a datetime object for now in the given timezone.
-        if (empty($date_string)) {
-            return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-        // if $date_string is matches something that looks like a Unix timestamp let's just use it.
-        if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
-            try {
-                // This is operating under the assumption that the incoming Unix timestamp
-                // is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
-                $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-                $DateTime->setTimestamp($date_string);
-
-                return $DateTime;
-            } catch (Exception $e) {
-                // should be rare, but if things got fooled then let's just continue
-            }
-        }
-        // not a unix timestamp.  So we will use the set format on this object and set timezone to
-        // create the DateTime object.
-        $format = $this->_date_format . ' ' . $this->_time_format;
-        try {
-            $DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
-            if (! $DateTime instanceof DbSafeDateTime) {
-                throw new EE_Error(
-                    sprintf(
-                        esc_html__(
-                            '"%1$s" does not represent a valid Date Time in the format "%2$s".',
-                            'event_espresso'
-                        ),
-                        $date_string,
-                        $format
-                    )
-                );
-            }
-        } catch (Exception $e) {
-            // if we made it here then likely then something went really wrong.
-            // Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
-            $DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
-        }
-
-        return $DateTime;
-    }
-
-
-    /**
-     * get_timezone_transitions
-     *
-     * @param DateTimeZone $DateTimeZone
-     * @param int|null     $time
-     * @param bool|null    $first_only
-     * @return array
-     */
-    public function get_timezone_transitions(
-        DateTimeZone $DateTimeZone,
-        ?int $time = null,
-        bool $first_only = true
-    ): array {
-        return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
-    }
-
-
-    /**
-     * get_timezone_offset
-     *
-     * @param DateTimeZone    $DateTimeZone
-     * @param int|string|null $time
-     * @return mixed
-     * @throws DomainException
-     */
-    public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
-    {
-        return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
-    }
-
-
-    /**
-     * This will take an incoming timezone string and return the abbreviation for that timezone
-     *
-     * @param string|null $timezone_string
-     * @return string           abbreviation
-     * @throws Exception
-     */
-    public function get_timezone_abbrev(?string $timezone_string = ''): string
-    {
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
-        $dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
-        return $dateTime->format('T');
-    }
-
-
-    /**
-     * Overrides the parent to allow for having a dynamic "now" value
-     *
-     * @return mixed
-     */
-    public function get_default_value()
-    {
-        if ($this->_default_value === EE_Datetime_Field::now) {
-            return time();
-        }
-        return parent::get_default_value();
-    }
-
-
-    /**
-     * Gets the default datetime object from the field's default time
-     *
-     * @return DbSafeDateTime|DateTime|null
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws Exception
-     * @since 4.9.66.p
-     */
-    public function getDefaultDateTimeObj()
-    {
-        $default_raw = $this->get_default_value();
-        if ($default_raw instanceof DateTime) {
-            return $default_raw;
-        }
-        if (is_null($default_raw)) {
-            return null;
-        }
-        $timezone_string = EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone());
-        $timezone        = new DateTimeZone($timezone_string);
-
-        // can't pass unix timestamps directly to Datetime constructor
-        if (is_numeric($default_raw)) {
-            $datetime = new DbSafeDateTime();
-            $datetime->setTimestamp($default_raw);
-            return $datetime;
-        }
-        return new DbSafeDateTime($default_raw, $timezone);
-    }
-
-
-    public function getSchemaDescription(): string
-    {
-        return sprintf(
-            esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
-            $this->get_nicename()
-        );
-    }
+	/**
+	 * The pattern we're looking for is if only the characters 0-9 are found and there are only
+	 * 10 or more numbers (because 9 numbers even with all 9's would be sometime in 2001 )
+	 *
+	 * @type string unix_timestamp_regex
+	 */
+	const unix_timestamp_regex = '/[0-9]{10,}/';
+
+	/**
+	 * @type string mysql_timestamp_format
+	 */
+	const mysql_timestamp_format = 'Y-m-d H:i:s';
+
+	/**
+	 * @type string mysql_date_format
+	 */
+	const mysql_date_format = 'Y-m-d';
+
+	/**
+	 * @type string mysql_time_format
+	 */
+	const mysql_time_format = 'H:i:s';
+
+	/**
+	 * Const for using in the default value. If the field's default is set to this,
+	 * then we will return the time of calling `get_default_value()`, not
+	 * just the current time at construction
+	 */
+	const now = 'now';
+
+	/**
+	 * The following properties hold the default formats for date and time.
+	 * Defaults are set via the constructor and can be overridden on class instantiation.
+	 * However they can also be overridden later by the set_format() method
+	 * (and corresponding set_date_format, set_time_format methods);
+	 */
+
+	protected string        $_date_format        = '';
+
+	protected string        $_time_format        = '';
+
+	protected string        $_pretty_date_format = '';
+
+	protected string        $_pretty_time_format = '';
+
+	protected ?DateTimeZone $_DateTimeZone       = null;
+
+	protected ?DateTimeZone $_UTC_DateTimeZone   = null;
+
+	protected ?DateTimeZone $_blog_DateTimeZone  = null;
+
+
+	/**
+	 * This property holds how we want the output returned when getting a datetime string.  It is set for the
+	 * set_date_time_output() method.  By default this is empty.  When empty, we are assuming that we want both date
+	 * and time returned via getters.
+	 *
+	 * @var mixed (null|string)
+	 */
+	protected $_date_time_output;
+
+
+	/**
+	 * timezone string
+	 * This gets set by the constructor and can be changed 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.  Default timezone is the current WP timezone option setting
+	 */
+	protected ?string $_timezone_string = null;
+
+
+	/**
+	 * This holds whatever UTC offset for the blog (we automatically convert timezone strings into their related
+	 * offsets for comparison purposes).
+	 *
+	 * @var int
+	 */
+	protected int $_blog_offset = 0;
+
+
+	/**
+	 * @param string      $table_column
+	 * @param string      $nice_name
+	 * @param bool        $nullable
+	 * @param string|null $default_value
+	 * @param string|null $timezone_string
+	 * @param string|null $date_format
+	 * @param string|null $time_format
+	 * @param string|null $pretty_date_format
+	 * @param string|null $pretty_time_format
+	 * @throws InvalidArgumentException
+	 * @throws Exception
+	 */
+	public function __construct(
+		string $table_column,
+		string $nice_name,
+		bool $nullable,
+		?string $default_value,
+		?string $timezone_string = '',
+		?string $date_format = '',
+		?string $time_format = '',
+		?string $pretty_date_format = '',
+		?string $pretty_time_format = ''
+	) {
+		$this->set_date_format($date_format);
+		$this->set_time_format($time_format);
+		$this->set_date_format($pretty_date_format, true);
+		$this->set_time_format($pretty_time_format, true);
+
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->set_timezone($timezone_string);
+		$this->setSchemaType(SchemaType::STRING);
+		$this->setSchemaFormat(SchemaFormat::DATETIME);
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws Exception
+	 */
+	public function get_UTC_DateTimeZone(): DateTimeZone
+	{
+		return $this->_UTC_DateTimeZone instanceof DateTimeZone
+			? $this->_UTC_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string('UTC');
+	}
+
+
+	/**
+	 * @return DateTimeZone
+	 * @throws Exception
+	 */
+	public function get_blog_DateTimeZone(): DateTimeZone
+	{
+		return $this->_blog_DateTimeZone instanceof DateTimeZone
+			? $this->_blog_DateTimeZone
+			: $this->_create_timezone_object_from_timezone_string();
+	}
+
+
+	/**
+	 * this prepares any incoming date data and make sure its converted to a utc unix timestamp
+	 *
+	 * @param string|int $value_inputted_for_field_on_model_object  could be a string formatted date time or int unix
+	 *                                                              timestamp
+	 * @return DateTime
+	 * @throws Exception
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return $this->_get_date_object($value_inputted_for_field_on_model_object);
+	}
+
+
+	/**
+	 * This returns the format string to be used by getters depending on what the $_date_time_output property is set at.
+	 * getters need to know whether we're just returning the date or the time or both.  By default we return both.
+	 *
+	 * @param bool $pretty If we're returning the pretty formats or standard format string.
+	 * @return string    The final assembled format string.
+	 */
+	protected function _get_date_time_output(bool $pretty = false): string
+	{
+		switch ($this->_date_time_output) {
+			case 'time':
+				return $pretty
+					? $this->_pretty_time_format
+					: $this->_time_format;
+
+			case 'date':
+				return $pretty
+					? $this->_pretty_date_format
+					: $this->_date_format;
+
+			default:
+				return $pretty
+					? trim($this->_pretty_date_format . ' ' . $this->_pretty_time_format)
+					: trim($this->_date_format . ' ' . $this->_time_format);
+		}
+	}
+
+
+	/**
+	 * This just sets the $_date_time_output property so we can flag how date and times are formatted before being
+	 * returned (using the format properties)
+	 *
+	 * @param string|null $what acceptable values are 'time' or 'date'.
+	 *                          Any other value will be set but will always result
+	 *                          in both 'date' and 'time' being returned.
+	 * @return void
+	 */
+	public function set_date_time_output(?string $what = null)
+	{
+		$this->_date_time_output = $what;
+	}
+
+
+	/**
+	 * 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).
+	 * We also set some other properties in this method.
+	 *
+	 * @param string|null $timezone_string A valid timezone string as described by @link
+	 *                                     http://www.php.net/manual/en/timezones.php
+	 * @return void
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	public function set_timezone(?string $timezone_string = '')
+	{
+		if (empty($timezone_string) && $this->_timezone_string !== null) {
+			// leave the timezone AS-IS if we already have one and
+			// the function arg didn't provide one
+			return;
+		}
+		$timezone_string        = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$this->_timezone_string = ! empty($timezone_string)
+			? $timezone_string
+			: 'UTC';
+		$this->_DateTimeZone    = $this->_create_timezone_object_from_timezone_string($this->_timezone_string);
+	}
+
+
+	/**
+	 * _create_timezone_object_from_timezone_name
+	 *
+	 * @access protected
+	 * @param string|null $timezone_string
+	 * @return DateTimeZone
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 */
+	protected function _create_timezone_object_from_timezone_string(?string $timezone_string = ''): DateTimeZone
+	{
+		return new DateTimeZone(EEH_DTT_Helper::get_valid_timezone_string($timezone_string));
+	}
+
+
+	/**
+	 * This just returns whatever is set for the current timezone.
+	 *
+	 * @access public
+	 * @return string timezone string
+	 */
+	public function get_timezone(): ?string
+	{
+		return $this->_timezone_string;
+	}
+
+
+	/**
+	 * set the $_date_format property
+	 *
+	 * @access public
+	 * @param string $format a new date format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_date_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_date_format = new DateFormat($format);
+		} else {
+			$this->_date_format = new DateFormat($format);
+		}
+	}
+
+
+	/**
+	 * return the $_date_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_date_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_date_format
+			: $this->_date_format;
+	}
+
+
+	/**
+	 * set the $_time_format property
+	 *
+	 * @access public
+	 * @param string $format a new time format (corresponding to formats accepted by PHP date() function)
+	 * @param bool   $pretty Whether to set pretty format or not.
+	 * @return void
+	 */
+	public function set_time_format(string $format, bool $pretty = false)
+	{
+		if ($pretty) {
+			$this->_pretty_time_format = new TimeFormat($format);
+		} else {
+			$this->_time_format = new TimeFormat($format);
+		}
+	}
+
+
+	/**
+	 * return the $_time_format property value.
+	 *
+	 * @param bool $pretty Whether to get pretty format or not.
+	 * @return string
+	 */
+	public function get_time_format(bool $pretty = false): string
+	{
+		return $pretty
+			? $this->_pretty_time_format
+			: $this->_time_format;
+	}
+
+
+	/**
+	 * set the $_pretty_date_format property
+	 *
+	 * @access public
+	 * @param string|null $format a new pretty date format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_date_format(?string $format)
+	{
+		$this->set_date_format($format, true);
+	}
+
+
+	/**
+	 * set the $_pretty_time_format property
+	 *
+	 * @access public
+	 * @param string|null $format a new pretty time format (corresponding to formats accepted by PHP date() function)
+	 * @return void
+	 */
+	public function set_pretty_time_format(?string $format)
+	{
+		$this->set_time_format($format, true);
+	}
+
+
+	/**
+	 * Only sets the time portion of the datetime.
+	 *
+	 * @param string|DateTime $time_to_set_string like 8am OR a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_time($time_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($time_to_set_string instanceof DateTime) {
+			$parsed = [
+				'hour'   => $time_to_set_string->format('H'),
+				'minute' => $time_to_set_string->format('i'),
+				'second' => $time_to_set_string->format('s'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_time_format, $time_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setTime($parsed['hour'], $parsed['minute'], $parsed['second']);
+	}
+
+
+	/**
+	 * Only sets the date portion of the datetime.
+	 *
+	 * @param string|DateTime $date_to_set_string like Friday, January 8th or a DateTime object.
+	 * @param DateTime        $current            current DateTime object for the datetime field
+	 * @return DateTime
+	 */
+	public function prepare_for_set_with_new_date($date_to_set_string, DateTime $current): DateTime
+	{
+		// if $time_to_set_string is datetime object, then let's use it to set the parse array.
+		// Otherwise parse the string.
+		if ($date_to_set_string instanceof DateTime) {
+			$parsed = [
+				'year'  => $date_to_set_string->format('Y'),
+				'month' => $date_to_set_string->format('m'),
+				'day'   => $date_to_set_string->format('d'),
+			];
+		} else {
+			// parse incoming string
+			$parsed = date_parse_from_format($this->_date_format, $date_to_set_string);
+		}
+		EEH_DTT_Helper::setTimezone($current, $this->_DateTimeZone);
+		return $current->setDate($parsed['year'], $parsed['month'], $parsed['day']);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0 timezone).  When the
+	 * datetime gets to this stage it should ALREADY be in UTC time
+	 *
+	 * @param DateTime $DateTime
+	 * @return string formatted date time for given timezone
+	 * @throws EE_Error
+	 */
+	public function prepare_for_get($DateTime): string
+	{
+		return $this->_prepare_for_display($DateTime);
+	}
+
+
+	/**
+	 * This differs from prepare_for_get in that it considers whether the internal $_timezone differs
+	 * from the set wp timezone.  If so, then it returns the datetime string formatted via
+	 * _pretty_date_format, and _pretty_time_format.  However, it also appends a timezone
+	 * abbreviation to the date_string.
+	 *
+	 * @param mixed       $DateTime
+	 * @param string|null $schema
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function prepare_for_pretty_echoing($DateTime, ?string $schema = null): string
+	{
+		$schema = $schema ?: true;
+		return $this->_prepare_for_display($DateTime, $schema);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param DateTime|null $DateTime
+	 * @param bool|string   $schema
+	 * @return string
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	protected function _prepare_for_display(?DateTime $DateTime, $schema = false): string
+	{
+		if (! $DateTime instanceof DateTime) {
+			if ($this->_nullable) {
+				return '';
+			}
+			if (WP_DEBUG) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.',
+							'event_espresso'
+						),
+						$this->_nicename
+					)
+				);
+			}
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now);
+			EE_Error::add_error(
+				sprintf(
+					esc_html__(
+						'EE_Datetime_Field::_prepare_for_display requires a DateTime class to be the value for the $DateTime argument because the %s field is not nullable.  When WP_DEBUG is false, the value is set to "now" instead of throwing an exception.',
+						'event_espresso'
+					),
+					$this->_nicename
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+		}
+		$format_string = $this->_get_date_time_output($schema);
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		if ($schema) {
+			$timezone_string = '';
+			if ($this->_display_timezone()) {
+				// must be explicit because schema could equal true.
+				if ($schema === 'no_html') {
+					$timezone_string = ' (' . $DateTime->format('T') . ')';
+				} else {
+					$timezone_string = ' <span class="ee_dtt_timezone_string">(' . $DateTime->format('T') . ')</span>';
+				}
+			}
+
+			return $DateTime->format($format_string) . $timezone_string;
+		}
+		return $DateTime->format($format_string);
+	}
+
+
+	/**
+	 * This prepares the EE_DateTime value to be saved to the db as mysql timestamp (UTC +0
+	 * timezone).
+	 *
+	 * @param mixed $datetime_value u
+	 * @return string mysql timestamp in UTC
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function prepare_for_use_in_db($datetime_value): ?string
+	{
+		// we allow an empty value or DateTime object, but nothing else.
+		if (! empty($datetime_value) && ! $datetime_value instanceof DateTime) {
+			$datetime_value = $this->_get_date_object($datetime_value);
+			if (! $datetime_value instanceof DateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'The incoming value being prepared for setting in the database for the %1$s field must either be empty or a php DateTime object, instead of: %2$s %3$s',
+							'event_espresso'
+						),
+						$this->get_name(),
+						'<br />',
+						print_r($datetime_value, true)
+					)
+				);
+			}
+		}
+
+		if ($datetime_value instanceof DateTime) {
+			if (! $datetime_value instanceof DbSafeDateTime) {
+				$datetime_value = DbSafeDateTime::createFromDateTime($datetime_value);
+			}
+			EEH_DTT_Helper::setTimezone($datetime_value, $this->get_UTC_DateTimeZone());
+			return $datetime_value->format(
+				EE_Datetime_Field::mysql_timestamp_format
+			);
+		}
+
+		// if $datetime_value is empty, and ! $this->_nullable, use current_time() but set the GMT flag to true
+		return ! $this->_nullable
+			? current_time('mysql', true)
+			: null;
+	}
+
+
+	/**
+	 * This prepares the datetime for internal usage as a PHP DateTime object OR null (if nullable is
+	 * allowed)
+	 *
+	 * @param string $datetime_string mysql timestamp in UTC
+	 * @return  bool|DbSafeDateTime|null
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function prepare_for_set_from_db($datetime_string)
+	{
+		// if $datetime_value is empty, and ! $this->_nullable, just use time()
+		if (empty($datetime_string) && $this->_nullable) {
+			return null;
+		}
+		// datetime strings from the db should ALWAYS be in UTC+0, so use UTC_DateTimeZone when creating
+		$DateTime = empty($datetime_string)
+			? new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone())
+			: DbSafeDateTime::createFromFormat(
+				EE_Datetime_Field::mysql_timestamp_format,
+				$datetime_string,
+				$this->get_UTC_DateTimeZone()
+			);
+
+		if (! $DateTime instanceof DbSafeDateTime) {
+			// if still no datetime object, then let's just use now
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->get_UTC_DateTimeZone());
+		}
+		// THEN apply the field's set DateTimeZone
+		EEH_DTT_Helper::setTimezone($DateTime, $this->_DateTimeZone);
+		return $DateTime;
+	}
+
+
+	/**
+	 * All this method does is determine if we're going to display the timezone string or not on any output.
+	 * To determine this we check if the set timezone offset is different than the blog's set timezone offset.
+	 * If so, then true.
+	 *
+	 * @return bool true for yes false for no
+	 * @throws Exception
+	 */
+	protected function _display_timezone(): bool
+	{
+		// first let's do a comparison of timezone strings.
+		// If they match then we can get out without any further calculations
+		$blog_string = get_option('timezone_string');
+		if ($blog_string === $this->_timezone_string) {
+			return false;
+		}
+		// now we need to calc the offset for the timezone string so we can compare with the blog offset.
+		$this_offset = $this->get_timezone_offset($this->_DateTimeZone);
+		$blog_offset = $this->get_timezone_offset($this->get_blog_DateTimeZone());
+		// now compare
+		return $blog_offset !== $this_offset;
+	}
+
+
+	/**
+	 * This method returns a php DateTime object for setting on the EE_Base_Class model.
+	 * EE passes around DateTime objects because they are MUCH easier to manipulate and deal
+	 * with.
+	 *
+	 * @param int|string|DateTime $date_string            This should be the incoming date string.  It's assumed to be
+	 *                                                    in the format that is set on the date_field (or DateTime
+	 *                                                    object)!
+	 * @return DateTime
+	 * @throws Exception
+	 * @throws Exception
+	 */
+	protected function _get_date_object($date_string)
+	{
+		// first if this is an empty date_string and nullable is allowed, just return null.
+		if ($this->_nullable && empty($date_string)) {
+			return null;
+		}
+
+		// if incoming date
+		if ($date_string instanceof DateTime) {
+			EEH_DTT_Helper::setTimezone($date_string, $this->_DateTimeZone);
+			return $date_string;
+		}
+		// if empty date_string and made it here.
+		// Return a datetime object for now in the given timezone.
+		if (empty($date_string)) {
+			return new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+		// if $date_string is matches something that looks like a Unix timestamp let's just use it.
+		if (preg_match(EE_Datetime_Field::unix_timestamp_regex, $date_string)) {
+			try {
+				// This is operating under the assumption that the incoming Unix timestamp
+				// is an ACTUAL Unix timestamp and not the calculated one output by current_time('timestamp');
+				$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+				$DateTime->setTimestamp($date_string);
+
+				return $DateTime;
+			} catch (Exception $e) {
+				// should be rare, but if things got fooled then let's just continue
+			}
+		}
+		// not a unix timestamp.  So we will use the set format on this object and set timezone to
+		// create the DateTime object.
+		$format = $this->_date_format . ' ' . $this->_time_format;
+		try {
+			$DateTime = DbSafeDateTime::createFromFormat($format, $date_string, $this->_DateTimeZone);
+			if (! $DateTime instanceof DbSafeDateTime) {
+				throw new EE_Error(
+					sprintf(
+						esc_html__(
+							'"%1$s" does not represent a valid Date Time in the format "%2$s".',
+							'event_espresso'
+						),
+						$date_string,
+						$format
+					)
+				);
+			}
+		} catch (Exception $e) {
+			// if we made it here then likely then something went really wrong.
+			// Instead of throwing an exception, let's just return a DateTime object for now, in the set timezone.
+			$DateTime = new DbSafeDateTime(EE_Datetime_Field::now, $this->_DateTimeZone);
+		}
+
+		return $DateTime;
+	}
+
+
+	/**
+	 * get_timezone_transitions
+	 *
+	 * @param DateTimeZone $DateTimeZone
+	 * @param int|null     $time
+	 * @param bool|null    $first_only
+	 * @return array
+	 */
+	public function get_timezone_transitions(
+		DateTimeZone $DateTimeZone,
+		?int $time = null,
+		bool $first_only = true
+	): array {
+		return EEH_DTT_Helper::get_timezone_transitions($DateTimeZone, $time, $first_only);
+	}
+
+
+	/**
+	 * get_timezone_offset
+	 *
+	 * @param DateTimeZone    $DateTimeZone
+	 * @param int|string|null $time
+	 * @return mixed
+	 * @throws DomainException
+	 */
+	public function get_timezone_offset(DateTimeZone $DateTimeZone, $time = null)
+	{
+		return EEH_DTT_Helper::get_timezone_offset($DateTimeZone, $time);
+	}
+
+
+	/**
+	 * This will take an incoming timezone string and return the abbreviation for that timezone
+	 *
+	 * @param string|null $timezone_string
+	 * @return string           abbreviation
+	 * @throws Exception
+	 */
+	public function get_timezone_abbrev(?string $timezone_string = ''): string
+	{
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($timezone_string);
+		$dateTime        = new DateTime(EE_Datetime_Field::now, new DateTimeZone($timezone_string));
+		return $dateTime->format('T');
+	}
+
+
+	/**
+	 * Overrides the parent to allow for having a dynamic "now" value
+	 *
+	 * @return mixed
+	 */
+	public function get_default_value()
+	{
+		if ($this->_default_value === EE_Datetime_Field::now) {
+			return time();
+		}
+		return parent::get_default_value();
+	}
+
+
+	/**
+	 * Gets the default datetime object from the field's default time
+	 *
+	 * @return DbSafeDateTime|DateTime|null
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws Exception
+	 * @since 4.9.66.p
+	 */
+	public function getDefaultDateTimeObj()
+	{
+		$default_raw = $this->get_default_value();
+		if ($default_raw instanceof DateTime) {
+			return $default_raw;
+		}
+		if (is_null($default_raw)) {
+			return null;
+		}
+		$timezone_string = EEH_DTT_Helper::get_valid_timezone_string($this->get_timezone());
+		$timezone        = new DateTimeZone($timezone_string);
+
+		// can't pass unix timestamps directly to Datetime constructor
+		if (is_numeric($default_raw)) {
+			$datetime = new DbSafeDateTime();
+			$datetime->setTimestamp($default_raw);
+			return $datetime;
+		}
+		return new DbSafeDateTime($default_raw, $timezone);
+	}
+
+
+	public function getSchemaDescription(): string
+	{
+		return sprintf(
+			esc_html__('%s - the value for this field is in the timezone of the site.', 'event_espresso'),
+			$this->get_nicename()
+		);
+	}
 }