eventespresso / event-espresso-core

core/db_models/EEM_Change_Log.model.php

Indentation +220 added lines, -220 removed lines

@@ -9,89 +9,89 @@ 
  */
 class EEM_Change_Log extends EEM_Base
 {
-    /**
-     * the related object was created log type
-     */
-    const type_create = 'create';
+	/**
+	 * the related object was created log type
+	 */
+	const type_create = 'create';
 
-    /**
-     * the related object was updated (changed, or soft-deleted)
-     */
-    const type_update = 'update';
+	/**
+	 * the related object was updated (changed, or soft-deleted)
+	 */
+	const type_update = 'update';
 
-    /**
-     * the related object was trashed/restored/deleted
-     */
-    const type_delete = 'delete';
+	/**
+	 * the related object was trashed/restored/deleted
+	 */
+	const type_delete = 'delete';
 
-    /**
-     * the related item had something worth noting happen on it, but
-     * only for the purposes of debugging problems
-     */
-    const type_debug = 'debug';
+	/**
+	 * the related item had something worth noting happen on it, but
+	 * only for the purposes of debugging problems
+	 */
+	const type_debug = 'debug';
 
-    /**
-     * the related item had an error occur on it
-     */
-    const type_error = 'error';
+	/**
+	 * the related item had an error occur on it
+	 */
+	const type_error = 'error';
 
-    /**
-     * the related item is regarding some gateway interaction, like an IPN
-     * or request to process a payment
-     */
-    const type_gateway = 'gateway';
+	/**
+	 * the related item is regarding some gateway interaction, like an IPN
+	 * or request to process a payment
+	 */
+	const type_gateway = 'gateway';
 
 
-    protected static ?EEM_Change_Log $_instance = null;
+	protected static ?EEM_Change_Log $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item       = esc_html__('Log', 'event_espresso');
-        $this->plural_item         = esc_html__('Logs', 'event_espresso');
-        $this->_tables             = [
-            'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields             = [
-            'Log' => [
-                'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
-                'LOG_time'    => new EE_Datetime_Field(
-                    'LOG_time',
-                    esc_html__("Log Time", 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'OBJ_ID'      => new EE_Foreign_Key_String_Field(
-                    'OBJ_ID',
-                    esc_html__("Object ID (int or string)", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
-                    'OBJ_type',
-                    esc_html__("Object Type", 'event_espresso'),
-                    true,
-                    null,
-                    $models_this_can_attach_to
-                ),
-                'LOG_type'    => new EE_Plain_Text_Field(
-                    'LOG_type',
-                    esc_html__("Type of log entry", "event_espresso"),
-                    false,
-                    self::type_debug
-                ),
-                'LOG_message' => new EE_Maybe_Serialized_Text_Field(
-                    'LOG_message',
-                    esc_html__("Log Message (body)", 'event_espresso'),
-                    true
-                ),
-                /*
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item       = esc_html__('Log', 'event_espresso');
+		$this->plural_item         = esc_html__('Logs', 'event_espresso');
+		$this->_tables             = [
+			'Log' => new EE_Primary_Table('esp_log', 'LOG_ID'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields             = [
+			'Log' => [
+				'LOG_ID'      => new EE_Primary_Key_Int_Field('LOG_ID', esc_html__('Log ID', 'event_espresso')),
+				'LOG_time'    => new EE_Datetime_Field(
+					'LOG_time',
+					esc_html__("Log Time", 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'OBJ_ID'      => new EE_Foreign_Key_String_Field(
+					'OBJ_ID',
+					esc_html__("Object ID (int or string)", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'OBJ_type'    => new EE_Any_Foreign_Model_Name_Field(
+					'OBJ_type',
+					esc_html__("Object Type", 'event_espresso'),
+					true,
+					null,
+					$models_this_can_attach_to
+				),
+				'LOG_type'    => new EE_Plain_Text_Field(
+					'LOG_type',
+					esc_html__("Type of log entry", "event_espresso"),
+					false,
+					self::type_debug
+				),
+				'LOG_message' => new EE_Maybe_Serialized_Text_Field(
+					'LOG_message',
+					esc_html__("Log Message (body)", 'event_espresso'),
+					true
+				),
+				/*
                  * Note: when querying for a change log's user, the OBJ_ID and OBJ_type fields are used,
                  * not the LOG_wp_user field. E.g.,
                  * `EEM_Change_Log::instance()->get_all(array(array('WP_User.ID'=>1)))` will actually return
@@ -100,162 +100,162 @@ 
                  *  If you want the latter, you can't use the model's magic joining. E.g, you would need to do
                  * `EEM_Change_Log::instance()->get_all(array(array('LOG_wp_user' => 1)))`.
                  */
-                'LOG_wp_user' => new EE_WP_User_Field(
-                    'LOG_wp_user',
-                    esc_html__("User who was logged in while this occurred", 'event_espresso'),
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations    = [];
-        foreach ($models_this_can_attach_to as $model) {
-            if ($model != 'Change_Log') {
-                $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-            }
-        }
-        // use completely custom caps for this
-        unset($this->_cap_restriction_generators);
-        // caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
-        foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
-            $this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
-                = new EE_Return_None_Where_Conditions();
-        }
-        parent::__construct($timezone);
-    }
+				'LOG_wp_user' => new EE_WP_User_Field(
+					'LOG_wp_user',
+					esc_html__("User who was logged in while this occurred", 'event_espresso'),
+					true
+				),
+			],
+		];
+		$this->_model_relations    = [];
+		foreach ($models_this_can_attach_to as $model) {
+			if ($model != 'Change_Log') {
+				$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+			}
+		}
+		// use completely custom caps for this
+		unset($this->_cap_restriction_generators);
+		// caps-wise this is all-or-nothing: if you have the default role you can access anything, otherwise nothing
+		foreach ($this->_cap_contexts_to_cap_action_map as $cap_context => $action) {
+			$this->_cap_restrictions[ $cap_context ][ EE_Restriction_Generator_Base::get_default_restrictions_cap() ]
+				= new EE_Return_None_Where_Conditions();
+		}
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * @param string             $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
-     * @param array|string       $message  array|string of the message you want to record
-     * @param EE_Base_Class|null $related_model_obj
-     * @return EE_Change_Log
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function log(string $log_type, $message, ?EE_Base_Class $related_model_obj): EE_Change_Log
-    {
-        $obj_id   = null;
-        $obj_type = null;
-        if ($related_model_obj instanceof EE_Base_Class) {
-            $obj_id   = $related_model_obj->ID();
-            $obj_type = $related_model_obj->get_model()->get_this_model_name();
-        }
-        $log = EE_Change_Log::new_instance(
-            [
-                'LOG_type'    => $log_type,
-                'LOG_message' => $message,
-                'OBJ_ID'      => $obj_id,
-                'OBJ_type'    => $obj_type,
-            ]
-        );
-        $log->save();
-        return $log;
-    }
+	/**
+	 * @param string             $log_type !see the acceptable values of LOG_type in EEM__Change_Log::__construct
+	 * @param array|string       $message  array|string of the message you want to record
+	 * @param EE_Base_Class|null $related_model_obj
+	 * @return EE_Change_Log
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function log(string $log_type, $message, ?EE_Base_Class $related_model_obj): EE_Change_Log
+	{
+		$obj_id   = null;
+		$obj_type = null;
+		if ($related_model_obj instanceof EE_Base_Class) {
+			$obj_id   = $related_model_obj->ID();
+			$obj_type = $related_model_obj->get_model()->get_this_model_name();
+		}
+		$log = EE_Change_Log::new_instance(
+			[
+				'LOG_type'    => $log_type,
+				'LOG_message' => $message,
+				'OBJ_ID'      => $obj_id,
+				'OBJ_type'    => $obj_type,
+			]
+		);
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Adds a gateway log for the specified object, given its ID and type
-     *
-     * @param array|string $message
-     * @param int|string   $related_obj_id
-     * @param string       $related_obj_type
-     * @return EE_Change_Log
-     * @throws ReflectionException
-     * @throws EE_Error
-     */
-    public function gateway_log($message, $related_obj_id, string $related_obj_type): EE_Change_Log
-    {
-        if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
-                        "event_espresso"
-                    ),
-                    $related_obj_type
-                )
-            );
-        }
-        $log = EE_Change_Log::new_instance(
-            [
-                'LOG_type'    => EEM_Change_Log::type_gateway,
-                'LOG_message' => $message,
-                'OBJ_ID'      => $related_obj_id,
-                'OBJ_type'    => $related_obj_type,
-            ]
-        );
-        $log->save();
-        return $log;
-    }
+	/**
+	 * Adds a gateway log for the specified object, given its ID and type
+	 *
+	 * @param array|string $message
+	 * @param int|string   $related_obj_id
+	 * @param string       $related_obj_type
+	 * @return EE_Change_Log
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 */
+	public function gateway_log($message, $related_obj_id, string $related_obj_type): EE_Change_Log
+	{
+		if (! EE_Registry::instance()->is_model_name($related_obj_type)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"'%s' is not a model name. A model name must be provided when making a gateway log. Eg, 'Payment', 'Payment_Method', etc",
+						"event_espresso"
+					),
+					$related_obj_type
+				)
+			);
+		}
+		$log = EE_Change_Log::new_instance(
+			[
+				'LOG_type'    => EEM_Change_Log::type_gateway,
+				'LOG_message' => $message,
+				'OBJ_ID'      => $related_obj_id,
+				'OBJ_type'    => $related_obj_type,
+			]
+		);
+		$log->save();
+		return $log;
+	}
 
 
-    /**
-     * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
-     *
-     * @param array $query_params
-     * @return array of arrays
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_efficiently(array $query_params): array
-    {
-        return $this->_get_all_wpdb_results($query_params);
-    }
+	/**
+	 * Just gets the bare-bones wpdb results as an array in cases where efficiency is essential
+	 *
+	 * @param array $query_params
+	 * @return array of arrays
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_efficiently(array $query_params): array
+	{
+		return $this->_get_all_wpdb_results($query_params);
+	}
 
 
-    /**
-     * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
-     * models after this, they may be out-of-sync with the database
-     *
-     * @param DateTime $datetime
-     * @return false|int
-     * @throws EE_Error
-     */
-    public function delete_gateway_logs_older_than(DateTime $datetime)
-    {
-        global $wpdb;
-        return $wpdb->query(
-            $wpdb->prepare(
-                'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
-                EEM_Change_Log::type_gateway,
-                $datetime->format(EE_Datetime_Field::mysql_timestamp_format)
-            )
-        );
-    }
+	/**
+	 * Executes a database query to delete gateway logs. Does not affect model objects, so if you attempt to use
+	 * models after this, they may be out-of-sync with the database
+	 *
+	 * @param DateTime $datetime
+	 * @return false|int
+	 * @throws EE_Error
+	 */
+	public function delete_gateway_logs_older_than(DateTime $datetime)
+	{
+		global $wpdb;
+		return $wpdb->query(
+			$wpdb->prepare(
+				'DELETE FROM ' . $this->table() . ' WHERE LOG_type = %s AND LOG_time < %s',
+				EEM_Change_Log::type_gateway,
+				$datetime->format(EE_Datetime_Field::mysql_timestamp_format)
+			)
+		);
+	}
 
 
-    /**
-     * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
-     * map vai the given filter.
-     *
-     * @return array
-     */
-    public static function get_pretty_label_map_for_registered_types(): array
-    {
-        return apply_filters(
-            'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
-            [
-                self::type_create  => esc_html__("Create", "event_espresso"),
-                self::type_update  => esc_html__("Update", "event_espresso"),
-                self::type_delete  => esc_html__("Delete", "event_espresso"),
-                self::type_debug   => esc_html__("Debug", "event_espresso"),
-                self::type_error   => esc_html__("Error", "event_espresso"),
-                self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso'),
-            ]
-        );
-    }
+	/**
+	 * Returns the map of type to pretty label for identifiers used for `LOG_type`.  Client code can register their own
+	 * map vai the given filter.
+	 *
+	 * @return array
+	 */
+	public static function get_pretty_label_map_for_registered_types(): array
+	{
+		return apply_filters(
+			'FHEE__EEM_Change_Log__get_pretty_label_map_for_registered_types',
+			[
+				self::type_create  => esc_html__("Create", "event_espresso"),
+				self::type_update  => esc_html__("Update", "event_espresso"),
+				self::type_delete  => esc_html__("Delete", "event_espresso"),
+				self::type_debug   => esc_html__("Debug", "event_espresso"),
+				self::type_error   => esc_html__("Error", "event_espresso"),
+				self::type_gateway => esc_html__("Gateway Interaction (IPN or Direct Payment)", 'event_espresso'),
+			]
+		);
+	}
 
 
-    /**
-     * Return the pretty (localized) label for the given log type identifier.
-     *
-     * @param string $type_identifier
-     * @return string
-     */
-    public static function get_pretty_label_for_type(string $type_identifier): string
-    {
-        $type_identifier_map = self::get_pretty_label_map_for_registered_types();
-        // we fall back to the incoming type identifier if there is no localized label for it.
-        return $type_identifier_map[ $type_identifier ] ?? $type_identifier;
-    }
+	/**
+	 * Return the pretty (localized) label for the given log type identifier.
+	 *
+	 * @param string $type_identifier
+	 * @return string
+	 */
+	public static function get_pretty_label_for_type(string $type_identifier): string
+	{
+		$type_identifier_map = self::get_pretty_label_map_for_registered_types();
+		// we fall back to the incoming type identifier if there is no localized label for it.
+		return $type_identifier_map[ $type_identifier ] ?? $type_identifier;
+	}
 }

core/db_models/EEM_Datetime.model.php

Indentation +836 added lines, -836 removed lines

@@ -16,840 +16,840 @@
  */
 class EEM_Datetime extends EEM_Soft_Delete_Base
 {
-    protected static ?EEM_Datetime $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $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
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item           = esc_html__('Datetime', 'event_espresso');
-        $this->plural_item             = esc_html__('Datetimes', 'event_espresso');
-        $this->_tables                 = [
-            'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
-        ];
-        $this->_fields                 = [
-            'Datetime' => [
-                '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'
-                ),
-                'VNU_ID'          => new EE_Foreign_Key_Int_Field(
-                    'VNU_ID',
-                    __('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                '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'),
-                    false,
-                    EE_INF
-                ),
-                'DTT_sold'        => new EE_Integer_Field(
-                    'DTT_sold',
-                    esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
-                    false,
-                    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', 'event_espresso'),
-                    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        = [
-            'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Event'           => new EE_Belongs_To_Relation(),
-            'Checkin'         => new EE_Has_Many_Relation(),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Venue'           => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event_model           = 'Event';
-        $this->model_chain_to_password = $path_to_event_model;
-        $this->_model_chain_to_wp_user = $path_to_event_model;
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event_model,
-                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
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     * @throws InvalidInterfaceException
-     */
-    public function create_new_blank_datetime()
-    {
-        // makes sure timezone is always set.
-        $timezone_string = $this->get_timezone();
-        /**
-         * Filters the initial start date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $start_date Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $start_date = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
-            $this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
-        );
-        /**
-         * Filters the initial end date for the new datetime.
-         * Any time included in this value will be overridden later so use additional filters to modify the time.
-         *
-         * @param int $end_data Unix timestamp representing now + 30 days in seconds.
-         * @return int Unix timestamp
-         */
-        $end_date       = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
-            $this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
-        );
-        $blank_datetime = EE_Datetime::new_instance(
-            [
-                'DTT_EVT_start' => $start_date,
-                'DTT_EVT_end'   => $end_date,
-                'DTT_order'     => 1,
-                'DTT_reg_limit' => EE_INF_IN_DB,
-            ],
-            $timezone_string
-        );
-        /**
-         * Filters the initial start time and format for the new EE_Datetime instance.
-         *
-         * @param array $start_time An array having size 2.  First element is the time, second element is the time
-         *                          format.
-         * @return array
-         */
-        $start_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
-            ['8am', 'ga']
-        );
-        /**
-         * Filters the initial end time and format for the new EE_Datetime instance.
-         *
-         * @param array $end_time An array having size 2.  First element is the time, second element is the time
-         *                        format
-         * @return array
-         */
-        $end_time = apply_filters(
-            'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
-            ['5pm', 'ga']
-        );
-        $this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
-        $blank_datetime->set_start_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_start',
-                $start_time[0],
-                $start_time[1],
-                $timezone_string
-            )
-        );
-        $blank_datetime->set_end_time(
-            $this->convert_datetime_for_query(
-                'DTT_EVT_end',
-                $end_time[0],
-                $end_time[1],
-                $timezone_string
-            )
-        );
-        return [$blank_datetime];
-    }
-
-
-    /**
-     * Validates whether the start_time and end_time are in the expected format.
-     *
-     * @param array $start_time
-     * @param array $end_time
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     */
-    private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
-    {
-        if (! is_array($start_time)) {
-            throw new InvalidDataTypeException('start_time', $start_time, 'array');
-        }
-        if (! is_array($end_time)) {
-            throw new InvalidDataTypeException('end_time', $end_time, 'array');
-        }
-        if (count($start_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$start_time'
-                )
-            );
-        }
-        if (count($end_time) !== 2) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'The variable %1$s is expected to be an array with two elements.  The first item in the '
-                    . 'array should be a valid time string, the second item in the array should be a valid time format',
-                    '$end_time'
-                )
-            );
-        }
-    }
-
-
-    /**
-     * get event start date from db
-     *
-     * @access public
-     * @param int $EVT_ID
-     * @return EE_Datetime[] array on success, FALSE on fail
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    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(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions($query_params);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * 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(int $EVT_ID, $limit = 0)
-    {
-        $query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params    = $this->addDefaultWhereConditions($query_params);
-        $query_params    = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * @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(
-        int $EVT_ID,
-        bool $include_expired = false,
-        bool $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(
-        int $EVT_ID,
-        bool $try_to_exclude_expired = true,
-        bool $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(
-        int $EVT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultWhereConditions(
-            $query_params,
-            EEM_Base::default_where_conditions_this_only
-        );
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * 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(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit);
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * 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(
-        int $TKT_ID,
-        bool $include_expired = true,
-        bool $include_deleted = true,
-        $limit = 0
-    ) {
-        $prev_data_prep_value = $this->prepModelForQuery();
-        $where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
-        $query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
-        $query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
-        return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
-    }
-
-
-    /**
-     * 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(int $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       @see
-     *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @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 stdClass[]
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidArgumentException
-     */
-    public function get_dtt_months_and_years(array $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'] = ['>', $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,
-                    ['DTT_EVT_end' => ['>', $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']  = ['<', $current_time_for_DTT_EVT_end];
-                $where_params['Event.EVT_ID'] = ['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'] = ['<', $current_time_for_DTT_EVT_start];
-                $where_params['DTT_EVT_end']   = ['>', $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'] = ['!=', 'publish'];
-                break;
-        }
-        $query_params[0]          = $where_params;
-        $query_params['group_by'] = ['dtt_year', 'dtt_month'];
-        $query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
-
-        $query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
-            $this->get_timezone(),
-            'DTT_EVT_start'
-        );
-        $columns_to_select = [
-            'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
-            'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
-            'dtt_month_num' => ['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
-     * @throws ReflectionException
-     */
-    public function update_sold(array $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.
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = [])
-    {
-        $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 $query_params = [])
-    {
-        // only accept where conditions for this query.
-        $_where            = isset($query_params[0]) ? $query_params[0] : [];
-        $status_query_args = [
-            EE_Datetime::active   => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
-            ),
-            EE_Datetime::upcoming => array_merge(
-                $_where,
-                ['DTT_EVT_start' => ['>', time()]]
-            ),
-            EE_Datetime::expired  => array_merge(
-                $_where,
-                ['DTT_EVT_end' => ['<', 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 = [];
-        foreach ($status_query_args as $status => $status_where_conditions) {
-            $status_query_results[ $status ] = EEM_Datetime::count(
-                [$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 = [])
-    {
-        $count = $this->get_datetime_counts_by_status([$status], $query_params);
-        return ! empty($count[ $status ]) ? $count[ $status ] : 0;
-    }
-
-
-    /**
-     * @return bool|int
-     * @since   5.0.0.p
-     */
-    private function prepModelForQuery()
-    {
-        $prev_data_prep_value = $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);
-        return $prev_data_prep_value;
-    }
-
-
-    /**
-     * @param array    $query_params
-     * @param bool|int $prev_data_prep_value
-     * @return EE_Base_Class[]|EE_Datetime[]
-     * @throws EE_Error
-     * @since   5.0.0.p
-     */
-    private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value)
-    {
-        $result = $this->get_all($query_params);
-        $this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
-        return $result;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param int    $limit
-     * @param string $order_by
-     * @param string $order
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addDefaultQueryParams(array $query_params, $limit = 0, $order_by = 'DTT_EVT_start', $order = 'ASC')
-    {
-        $query_params = $this->addOrderByQueryParams($query_params, $order_by, $order);
-        $query_params = $this->addLimitQueryParams($query_params, $limit);
-        return $query_params;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $default_where_conditions
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addDefaultWhereConditions(
-        array $query_params,
-        $default_where_conditions = EEM_Base::default_where_conditions_none
-    ) {
-        $query_params['default_where_conditions'] = $default_where_conditions;
-        return $query_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @param bool  $include_expired
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addDefaultWhereParams(
-        array $where_params,
-        bool $include_deleted = true,
-        bool $include_expired = true
-    ) {
-        $where_params = $this->addExpiredWhereParams($where_params, $include_expired);
-        $where_params = $this->addDeletedWhereParams($where_params, $include_deleted);
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_deleted
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addDeletedWhereParams(array $where_params, bool $include_deleted = true)
-    {
-        $deleted                     = $include_deleted ? [true, false] : [false];
-        $where_params['DTT_deleted'] = ['IN', $deleted];
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @param bool  $include_expired
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addExpiredWhereParams(array $where_params, bool $include_expired = true)
-    {
-        if (! $include_expired) {
-            $where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
-        }
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param int   $limit
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addLimitQueryParams(array $query_params, $limit = 0)
-    {
-        if ($limit) {
-            $query_params['limit'] = $limit;
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * @param array  $query_params
-     * @param string $order_by
-     * @param string $order
-     * @return array
-     * @since   5.0.0.p
-     */
-    private function addOrderByQueryParams(array $query_params, $order_by = 'DTT_EVT_start', $order = 'ASC')
-    {
-        $order                    = $order === 'ASC' ? 'ASC' : 'DESC';
-        $valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
-        $order_by                 = in_array($order_by, $valid_order_columns, true) ? $order_by : 'DTT_EVT_start';
-        $query_params['order_by'] = [$order_by => $order];
-        return $query_params;
-    }
+	protected static ?EEM_Datetime $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $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
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item           = esc_html__('Datetime', 'event_espresso');
+		$this->plural_item             = esc_html__('Datetimes', 'event_espresso');
+		$this->_tables                 = [
+			'Datetime' => new EE_Primary_Table('esp_datetime', 'DTT_ID'),
+		];
+		$this->_fields                 = [
+			'Datetime' => [
+				'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'
+				),
+				'VNU_ID'          => new EE_Foreign_Key_Int_Field(
+					'VNU_ID',
+					__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'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'),
+					false,
+					EE_INF
+				),
+				'DTT_sold'        => new EE_Integer_Field(
+					'DTT_sold',
+					esc_html__('How many sales for this Datetime that have occurred', 'event_espresso'),
+					false,
+					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', 'event_espresso'),
+					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        = [
+			'Ticket'          => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Event'           => new EE_Belongs_To_Relation(),
+			'Checkin'         => new EE_Has_Many_Relation(),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Venue'           => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event_model           = 'Event';
+		$this->model_chain_to_password = $path_to_event_model;
+		$this->_model_chain_to_wp_user = $path_to_event_model;
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event_model,
+				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
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 * @throws InvalidInterfaceException
+	 */
+	public function create_new_blank_datetime()
+	{
+		// makes sure timezone is always set.
+		$timezone_string = $this->get_timezone();
+		/**
+		 * Filters the initial start date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $start_date Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$start_date = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_date',
+			$this->current_time_for_query('DTT_EVT_start', true) + MONTH_IN_SECONDS
+		);
+		/**
+		 * Filters the initial end date for the new datetime.
+		 * Any time included in this value will be overridden later so use additional filters to modify the time.
+		 *
+		 * @param int $end_data Unix timestamp representing now + 30 days in seconds.
+		 * @return int Unix timestamp
+		 */
+		$end_date       = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_date',
+			$this->current_time_for_query('DTT_EVT_end', true) + MONTH_IN_SECONDS
+		);
+		$blank_datetime = EE_Datetime::new_instance(
+			[
+				'DTT_EVT_start' => $start_date,
+				'DTT_EVT_end'   => $end_date,
+				'DTT_order'     => 1,
+				'DTT_reg_limit' => EE_INF_IN_DB,
+			],
+			$timezone_string
+		);
+		/**
+		 * Filters the initial start time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $start_time An array having size 2.  First element is the time, second element is the time
+		 *                          format.
+		 * @return array
+		 */
+		$start_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__start_time',
+			['8am', 'ga']
+		);
+		/**
+		 * Filters the initial end time and format for the new EE_Datetime instance.
+		 *
+		 * @param array $end_time An array having size 2.  First element is the time, second element is the time
+		 *                        format
+		 * @return array
+		 */
+		$end_time = apply_filters(
+			'FHEE__EEM_Datetime__create_new_blank_datetime__end_time',
+			['5pm', 'ga']
+		);
+		$this->validateStartAndEndTimeForBlankDate($start_time, $end_time);
+		$blank_datetime->set_start_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_start',
+				$start_time[0],
+				$start_time[1],
+				$timezone_string
+			)
+		);
+		$blank_datetime->set_end_time(
+			$this->convert_datetime_for_query(
+				'DTT_EVT_end',
+				$end_time[0],
+				$end_time[1],
+				$timezone_string
+			)
+		);
+		return [$blank_datetime];
+	}
+
+
+	/**
+	 * Validates whether the start_time and end_time are in the expected format.
+	 *
+	 * @param array $start_time
+	 * @param array $end_time
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 */
+	private function validateStartAndEndTimeForBlankDate(array $start_time, array $end_time)
+	{
+		if (! is_array($start_time)) {
+			throw new InvalidDataTypeException('start_time', $start_time, 'array');
+		}
+		if (! is_array($end_time)) {
+			throw new InvalidDataTypeException('end_time', $end_time, 'array');
+		}
+		if (count($start_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$start_time'
+				)
+			);
+		}
+		if (count($end_time) !== 2) {
+			throw new InvalidArgumentException(
+				sprintf(
+					'The variable %1$s is expected to be an array with two elements.  The first item in the '
+					. 'array should be a valid time string, the second item in the array should be a valid time format',
+					'$end_time'
+				)
+			);
+		}
+	}
+
+
+	/**
+	 * get event start date from db
+	 *
+	 * @access public
+	 * @param int $EVT_ID
+	 * @return EE_Datetime[] array on success, FALSE on fail
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	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(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions($query_params);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * 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(int $EVT_ID, $limit = 0)
+	{
+		$query_params[0] = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params    = $this->addDefaultWhereConditions($query_params);
+		$query_params    = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * @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(
+		int $EVT_ID,
+		bool $include_expired = false,
+		bool $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(
+		int $EVT_ID,
+		bool $try_to_exclude_expired = true,
+		bool $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(
+		int $EVT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Event.EVT_ID' => absint($EVT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultWhereConditions(
+			$query_params,
+			EEM_Base::default_where_conditions_this_only
+		);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * 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(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit);
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * 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(
+		int $TKT_ID,
+		bool $include_expired = true,
+		bool $include_deleted = true,
+		$limit = 0
+	) {
+		$prev_data_prep_value = $this->prepModelForQuery();
+		$where_params         = ['Ticket.TKT_ID' => absint($TKT_ID)];
+		$query_params[0]      = $this->addDefaultWhereParams($where_params, $include_deleted, $include_expired);
+		$query_params         = $this->addDefaultQueryParams($query_params, $limit, 'DTT_order');
+		return $this->getDatetimesAndRestoreModel($query_params, $prev_data_prep_value);
+	}
+
+
+	/**
+	 * 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(int $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       @see
+	 *                                   https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @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 stdClass[]
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidArgumentException
+	 */
+	public function get_dtt_months_and_years(array $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'] = ['>', $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,
+					['DTT_EVT_end' => ['>', $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']  = ['<', $current_time_for_DTT_EVT_end];
+				$where_params['Event.EVT_ID'] = ['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'] = ['<', $current_time_for_DTT_EVT_start];
+				$where_params['DTT_EVT_end']   = ['>', $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'] = ['!=', 'publish'];
+				break;
+		}
+		$query_params[0]          = $where_params;
+		$query_params['group_by'] = ['dtt_year', 'dtt_month'];
+		$query_params             = $this->addOrderByQueryParams($query_params, 'DTT_EVT_start', 'DESC');
+
+		$query_interval    = EEH_DTT_Helper::get_sql_query_interval_for_offset(
+			$this->get_timezone(),
+			'DTT_EVT_start'
+		);
+		$columns_to_select = [
+			'dtt_year'      => ['YEAR(' . $query_interval . ')', '%s'],
+			'dtt_month'     => ['MONTHNAME(' . $query_interval . ')', '%s'],
+			'dtt_month_num' => ['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
+	 * @throws ReflectionException
+	 */
+	public function update_sold(array $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.
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = [])
+	{
+		$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 $query_params = [])
+	{
+		// only accept where conditions for this query.
+		$_where            = isset($query_params[0]) ? $query_params[0] : [];
+		$status_query_args = [
+			EE_Datetime::active   => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['<', time()], 'DTT_EVT_end' => ['>', time()]]
+			),
+			EE_Datetime::upcoming => array_merge(
+				$_where,
+				['DTT_EVT_start' => ['>', time()]]
+			),
+			EE_Datetime::expired  => array_merge(
+				$_where,
+				['DTT_EVT_end' => ['<', 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 = [];
+		foreach ($status_query_args as $status => $status_where_conditions) {
+			$status_query_results[ $status ] = EEM_Datetime::count(
+				[$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 = [])
+	{
+		$count = $this->get_datetime_counts_by_status([$status], $query_params);
+		return ! empty($count[ $status ]) ? $count[ $status ] : 0;
+	}
+
+
+	/**
+	 * @return bool|int
+	 * @since   5.0.0.p
+	 */
+	private function prepModelForQuery()
+	{
+		$prev_data_prep_value = $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);
+		return $prev_data_prep_value;
+	}
+
+
+	/**
+	 * @param array    $query_params
+	 * @param bool|int $prev_data_prep_value
+	 * @return EE_Base_Class[]|EE_Datetime[]
+	 * @throws EE_Error
+	 * @since   5.0.0.p
+	 */
+	private function getDatetimesAndRestoreModel(array $query_params, $prev_data_prep_value)
+	{
+		$result = $this->get_all($query_params);
+		$this->assume_values_already_prepared_by_model_object($prev_data_prep_value);
+		return $result;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param int    $limit
+	 * @param string $order_by
+	 * @param string $order
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addDefaultQueryParams(array $query_params, $limit = 0, $order_by = 'DTT_EVT_start', $order = 'ASC')
+	{
+		$query_params = $this->addOrderByQueryParams($query_params, $order_by, $order);
+		$query_params = $this->addLimitQueryParams($query_params, $limit);
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $default_where_conditions
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addDefaultWhereConditions(
+		array $query_params,
+		$default_where_conditions = EEM_Base::default_where_conditions_none
+	) {
+		$query_params['default_where_conditions'] = $default_where_conditions;
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addDefaultWhereParams(
+		array $where_params,
+		bool $include_deleted = true,
+		bool $include_expired = true
+	) {
+		$where_params = $this->addExpiredWhereParams($where_params, $include_expired);
+		$where_params = $this->addDeletedWhereParams($where_params, $include_deleted);
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_deleted
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addDeletedWhereParams(array $where_params, bool $include_deleted = true)
+	{
+		$deleted                     = $include_deleted ? [true, false] : [false];
+		$where_params['DTT_deleted'] = ['IN', $deleted];
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @param bool  $include_expired
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addExpiredWhereParams(array $where_params, bool $include_expired = true)
+	{
+		if (! $include_expired) {
+			$where_params['DTT_EVT_end'] = ['>=', current_time('mysql', true)];
+		}
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param int   $limit
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addLimitQueryParams(array $query_params, $limit = 0)
+	{
+		if ($limit) {
+			$query_params['limit'] = $limit;
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * @param array  $query_params
+	 * @param string $order_by
+	 * @param string $order
+	 * @return array
+	 * @since   5.0.0.p
+	 */
+	private function addOrderByQueryParams(array $query_params, $order_by = 'DTT_EVT_start', $order = 'ASC')
+	{
+		$order                    = $order === 'ASC' ? 'ASC' : 'DESC';
+		$valid_order_columns      = ['DTT_ID', 'DTT_EVT_start', 'DTT_EVT_end', 'DTT_order'];
+		$order_by                 = in_array($order_by, $valid_order_columns, true) ? $order_by : 'DTT_EVT_start';
+		$query_params['order_by'] = [$order_by => $order];
+		return $query_params;
+	}
 }

core/db_models/EEM_Message_Template_Group.model.php

Indentation +432 added lines, -432 removed lines

@@ -13,436 +13,436 @@
  */
 class EEM_Message_Template_Group extends EEM_Soft_Delete_Base
 {
-    protected static ?EEM_Message_Template_Group $_instance = null;
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
-        $this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
-        $this->_tables          = [
-            'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
-        ];
-        $this->_fields          = [
-            'Message_Template_Group' => [
-                'GRP_ID'           => new EE_Primary_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Message Template Group ID', 'event_espresso')
-                ),
-                'MTP_name'         => new EE_Plain_Text_Field(
-                    'MTP_name',
-                    esc_html__('The name of the template group', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'MTP_description'  => new EE_Simple_HTML_Field(
-                    'MTP_description',
-                    esc_html__(
-                        'A brief description about this template.',
-                        'event_espresso'
-                    ),
-                    false,
-                    ''
-                ),
-                'MTP_user_id'      => new EE_WP_User_Field(
-                    'MTP_user_id',
-                    esc_html__('Template Creator ID', 'event_espresso'),
-                    false
-                ),
-                'MTP_messenger'    => new EE_Plain_Text_Field(
-                    'MTP_messenger',
-                    esc_html__(
-                        'Messenger Used for Template',
-                        'event_espresso'
-                    ),
-                    false,
-                    'email'
-                ),
-                'MTP_message_type' => new EE_Plain_Text_Field(
-                    'MTP_message_type',
-                    esc_html__('Message Type', 'event_espresso'),
-                    false,
-                    'registration'
-                ),
-                'MTP_is_global'    => new EE_Boolean_Field(
-                    'MTP_is_global',
-                    esc_html__(
-                        'Flag indicating if Template Group is Global',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-                'MTP_is_override'  => new EE_Boolean_Field(
-                    'MTP_is_override',
-                    esc_html__(
-                        'Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'MTP_deleted'      => new EE_Trashed_Flag_Field(
-                    'MTP_deleted',
-                    esc_html__(
-                        'Flag indicating whether this has been trashed',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'MTP_is_active'    => new EE_Boolean_Field(
-                    'MTP_is_active',
-                    esc_html__(
-                        'Flag indicating whether template group is active',
-                        'event_espresso'
-                    ),
-                    false,
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Message_Template' => new EE_Has_Many_Relation(),
-            'Message'          => new EE_Has_Many_Relation(),
-            'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
-            'WP_User'          => new EE_Belongs_To_Relation(),
-        ];
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * get_all_trashed_message_templates_by_event
-     *
-     * @access public
-     * @param int    $EVT_ID specific event id
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return array message template objects that are attached to a specific event.
-     */
-    public function get_all_trashed_message_templates_by_event(
-        $EVT_ID,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false
-    ) {
-        $query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * get_all_message_templates_by_messenger
-     *
-     * @access public
-     * @param        $messenger
-     * @param string $orderby
-     * @param string $order
-     * @return array all (including trashed or inactive) message template group objects for the given messenger
-     */
-    public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
-    {
-        return $this->get_all_deleted_and_undeleted(
-            [['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
-        );
-    }
-
-
-    /**
-     * This simply adds on any messenger/message type filters that may be present in the request
-     *
-     * @param array $_where any existing where conditions to append these to.
-     * @return array          original where conditions or original with additional filters.
-     */
-    protected function _maybe_mtp_filters($_where = [])
-    {
-        /** @var RequestInterface $request */
-        $request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-        $messenger = $request->getRequestParam('ee_messenger_filter_by');
-        // account for messenger or message type filters
-        if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
-            $_where['MTP_messenger'] = $messenger;
-        }
-        $message_type = $request->getRequestParam('ee_message_type_filter_by');
-        if (
-            $message_type !== '' && $message_type !== 'none_selected'
-        ) {
-            $_where['MTP_message_type'] = $message_type;
-        }
-
-        return $_where;
-    }
-
-
-    /**
-     * get_all_active_message_templates groups
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @param bool   $user_check
-     * @return array|int all active (non_trashed, active) message template objects
-     */
-    public function get_all_active_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true,
-        $user_check = false
-    ) {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        if (
-            $user_check
-            && ! $global
-            && ! EE_Registry::instance()->CAP->current_user_can(
-                'ee_read_others_messages',
-                'get_all_active_message_templates'
-            )
-        ) {
-            $_where['MTP_user_id'] = get_current_user_id();
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     *    retrieve ALL message_template groups from db regardless of wht
-     *
-     * @access    public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @return mixed array on success, FALSE on fail
-     */
-    public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
-    {
-        $_where = $this->_maybe_mtp_filters();
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        $r_templates = $count
-            ? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
-            : $this->get_all_deleted_and_undeleted($query_params);
-
-        return $r_templates;
-    }
-
-
-    /**
-     * This gets all the custom templates attached to a specific event
-     *
-     * @param int   $EVT_ID       event id
-     * @param array $query_params @see
-     *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     * @return  EE_Message_Template_Group[]
-     */
-    public function get_all_custom_templates_by_event($EVT_ID, $query_params = [])
-    {
-        $where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
-        return $this->get_all(
-            [$where]
-        );
-    }
-
-
-    /**
-     * get_all_trashed_grouped_message_templates
-     * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
-     *
-     * @access public
-     * @param string $orderby
-     * @param string $order
-     * @param null   $limit
-     * @param bool   $count
-     * @param bool   $global
-     * @return array|int EE_Message_Template_Group[] message template groups.
-     */
-    public function get_all_trashed_grouped_message_templates(
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $global = true
-    ) {
-        $_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
-        $_where['MTP_is_active'] = true;
-        $_where                  = $this->_maybe_mtp_filters($_where);
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
-    }
-
-
-    /**
-     * this returns the message template group(s) for a given event, messenger, and message template
-     *
-     * @param string              $messenger
-     * @param string              $message_type
-     * @param                     $evt_id
-     * @param string              $orderby pointless at this point but still included
-     * @param string              $order
-     * @param mixed (array|null) $limit   array($offset, $num)
-     * @param bool                $count   true = just return count, false = objects
-     * @param bool                $active  ignore "active" or not. (default only return active)
-     * @return \mixed[]) depending on $count.
-     */
-    public function get_event_message_templates_by_m_and_mt_and_evt(
-        $messenger,
-        $message_type,
-        $evt_id,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'Event.EVT_ID'     => $evt_id,
-            'MTP_is_global'    => true,
-            'MTP_is_active'    => $active,
-        ];
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all GLOBAL message template groups for the given messenger and message type
-     *
-     * @param string $messenger     slug for messenger
-     * @param string $message_type  slug for message type
-     * @param string $orderby       what column to orderby
-     * @param string $order         ASC or DESC
-     * @param mixed (array|null) $limit array($offset, $num)
-     * @param bool   $count         true = just return count, false = objects
-     * @param bool   $active        ignore "active" or not. (default only return active) -
-     *                              'all' means return both inactive AND inactive.
-     * @return array               message template objects that are global (i.e. non-event)
-     */
-    public function get_global_message_template_by_m_and_mt(
-        $messenger,
-        $message_type,
-        $orderby = 'GRP_ID',
-        $order = 'ASC',
-        $limit = null,
-        $count = false,
-        $active = true
-    ) {
-        $_where = [
-            'MTP_messenger'    => $messenger,
-            'MTP_message_type' => $message_type,
-            'MTP_is_global'    => true,
-        ];
-
-        if ($active != 'all') {
-            $_where['MTP_is_active'] = $active;
-        }
-
-        $query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
-
-        return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
-    }
-
-
-    /**
-     * get all custom message template groups for the given messenger and message type
-     *
-     * @param string $messenger    messenger
-     * @param string $message_type messagetype
-     * @param array  $query_params same as EEM_Base->get_all()
-     * @return EE_Message_Template_Group[]
-     */
-    public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = [])
-    {
-        return $this->get_all(
-            array_merge(
-                $query_params,
-                [
-                    [
-                        'MTP_is_global'    => false,
-                        'MTP_messenger'    => $messenger,
-                        'MTP_message_type' => $message_type,
-                    ],
-                ]
-            )
-        );
-    }
-
-
-    /**
-     * This sends things to the validator for the given messenger and message type.
-     *
-     * @param array  $fields       the incoming fields to check.
-     *                             Note this array is in the formatted fields from the form fields setup.
-     *                             So we need to reformat this into an array of expected field refs by the validator.
-     *                             Note also that this is not only the fields for the Message Template Group
-     *                             but ALSO for Message Template.
-     * @param string $context      The context the fields were obtained from.
-     * @param string $messenger    The messenger we are validating
-     * @param string $message_type The message type we are validating.
-     * @return bool
-     * @throws DomainException
-     */
-    public function validate(array $fields, string $context, string $messenger, string $message_type): bool
-    {
-        /** @var MessageTemplateValidator $validator */
-        $validator = LoaderFactory::getShared(MessageTemplateValidator::class);
-        return $validator->validateTemplateFields($messenger, $message_type, $context, $fields);
-    }
-
-
-    /**
-     * Updates all message template groups matching the incoming arguments to inactive status.
-     *
-     * @param array $messenger_names    The messenger slugs.
-     *                                  If empty then all templates matching the message types are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @param array $message_type_names The message type slugs.
-     *                                  If empty then all templates matching the messengers are marked inactive.
-     *                                  Otherwise only templates matching the messengers and message types.
-     * @return int  count of updated records.
-     */
-    public function deactivate_message_template_groups_for($messenger_names = [], $message_type_names = [])
-    {
-        $query_args = [];
-        if (empty($messenger_names) && empty($message_type_names)) {
-            return 0;
-        }
-        if (! empty($messenger_names)) {
-            $query_args[0]['MTP_messenger'] = ['IN', (array) $messenger_names];
-        }
-        if (! empty($message_type_names)) {
-            $query_args[0]['MTP_message_type'] = ['IN', (array) $message_type_names];
-        }
-        return $this->update(['MTP_is_active' => false], $query_args);
-    }
+	protected static ?EEM_Message_Template_Group $_instance = null;
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Message Template Group', 'event_espresso');
+		$this->plural_item      = esc_html__('Message Template Groups', 'event_espresso');
+		$this->_tables          = [
+			'Message_Template_Group' => new EE_Primary_Table('esp_message_template_group', 'GRP_ID'),
+		];
+		$this->_fields          = [
+			'Message_Template_Group' => [
+				'GRP_ID'           => new EE_Primary_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Message Template Group ID', 'event_espresso')
+				),
+				'MTP_name'         => new EE_Plain_Text_Field(
+					'MTP_name',
+					esc_html__('The name of the template group', 'event_espresso'),
+					false,
+					''
+				),
+				'MTP_description'  => new EE_Simple_HTML_Field(
+					'MTP_description',
+					esc_html__(
+						'A brief description about this template.',
+						'event_espresso'
+					),
+					false,
+					''
+				),
+				'MTP_user_id'      => new EE_WP_User_Field(
+					'MTP_user_id',
+					esc_html__('Template Creator ID', 'event_espresso'),
+					false
+				),
+				'MTP_messenger'    => new EE_Plain_Text_Field(
+					'MTP_messenger',
+					esc_html__(
+						'Messenger Used for Template',
+						'event_espresso'
+					),
+					false,
+					'email'
+				),
+				'MTP_message_type' => new EE_Plain_Text_Field(
+					'MTP_message_type',
+					esc_html__('Message Type', 'event_espresso'),
+					false,
+					'registration'
+				),
+				'MTP_is_global'    => new EE_Boolean_Field(
+					'MTP_is_global',
+					esc_html__(
+						'Flag indicating if Template Group is Global',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+				'MTP_is_override'  => new EE_Boolean_Field(
+					'MTP_is_override',
+					esc_html__(
+						'Flag indicating if Template Group overrides any other Templates for the messenger/messagetype combination',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'MTP_deleted'      => new EE_Trashed_Flag_Field(
+					'MTP_deleted',
+					esc_html__(
+						'Flag indicating whether this has been trashed',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'MTP_is_active'    => new EE_Boolean_Field(
+					'MTP_is_active',
+					esc_html__(
+						'Flag indicating whether template group is active',
+						'event_espresso'
+					),
+					false,
+					true
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Message_Template' => new EE_Has_Many_Relation(),
+			'Message'          => new EE_Has_Many_Relation(),
+			'Event'            => new EE_HABTM_Relation('Event_Message_Template'),
+			'WP_User'          => new EE_Belongs_To_Relation(),
+		];
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_Global('MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * get_all_trashed_message_templates_by_event
+	 *
+	 * @access public
+	 * @param int    $EVT_ID specific event id
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return array message template objects that are attached to a specific event.
+	 */
+	public function get_all_trashed_message_templates_by_event(
+		$EVT_ID,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false
+	) {
+		$query_params = [['Event.EVT_ID' => $EVT_ID], 'order_by' => [$orderby => $order], 'limit' => $limit];
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * get_all_message_templates_by_messenger
+	 *
+	 * @access public
+	 * @param        $messenger
+	 * @param string $orderby
+	 * @param string $order
+	 * @return array all (including trashed or inactive) message template group objects for the given messenger
+	 */
+	public function get_all_message_templates_by_messenger($messenger, $orderby = 'GRP_ID', $order = 'ASC')
+	{
+		return $this->get_all_deleted_and_undeleted(
+			[['MTP_messenger' => $messenger], 'order_by' => [$orderby => $order]]
+		);
+	}
+
+
+	/**
+	 * This simply adds on any messenger/message type filters that may be present in the request
+	 *
+	 * @param array $_where any existing where conditions to append these to.
+	 * @return array          original where conditions or original with additional filters.
+	 */
+	protected function _maybe_mtp_filters($_where = [])
+	{
+		/** @var RequestInterface $request */
+		$request   = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+		$messenger = $request->getRequestParam('ee_messenger_filter_by');
+		// account for messenger or message type filters
+		if ($messenger !== '' && $messenger !== 'none_selected' && $messenger !== 'all') {
+			$_where['MTP_messenger'] = $messenger;
+		}
+		$message_type = $request->getRequestParam('ee_message_type_filter_by');
+		if (
+			$message_type !== '' && $message_type !== 'none_selected'
+		) {
+			$_where['MTP_message_type'] = $message_type;
+		}
+
+		return $_where;
+	}
+
+
+	/**
+	 * get_all_active_message_templates groups
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @param bool   $user_check
+	 * @return array|int all active (non_trashed, active) message template objects
+	 */
+	public function get_all_active_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true,
+		$user_check = false
+	) {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		if (
+			$user_check
+			&& ! $global
+			&& ! EE_Registry::instance()->CAP->current_user_can(
+				'ee_read_others_messages',
+				'get_all_active_message_templates'
+			)
+		) {
+			$_where['MTP_user_id'] = get_current_user_id();
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 *    retrieve ALL message_template groups from db regardless of wht
+	 *
+	 * @access    public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @return mixed array on success, FALSE on fail
+	 */
+	public function get_all_message_templates($orderby = 'GRP_ID', $order = 'ASC', $limit = null, $count = false)
+	{
+		$_where = $this->_maybe_mtp_filters();
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		$r_templates = $count
+			? $this->count_deleted_and_undeleted($query_params, 'GRP_ID', true)
+			: $this->get_all_deleted_and_undeleted($query_params);
+
+		return $r_templates;
+	}
+
+
+	/**
+	 * This gets all the custom templates attached to a specific event
+	 *
+	 * @param int   $EVT_ID       event id
+	 * @param array $query_params @see
+	 *                            https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 * @return  EE_Message_Template_Group[]
+	 */
+	public function get_all_custom_templates_by_event($EVT_ID, $query_params = [])
+	{
+		$where = array_merge($query_params, ['Event.EVT_ID' => $EVT_ID]);
+		return $this->get_all(
+			[$where]
+		);
+	}
+
+
+	/**
+	 * get_all_trashed_grouped_message_templates
+	 * this returns ONLY the template groups where ALL contexts are trashed and none of the group are non-trashed
+	 *
+	 * @access public
+	 * @param string $orderby
+	 * @param string $order
+	 * @param null   $limit
+	 * @param bool   $count
+	 * @param bool   $global
+	 * @return array|int EE_Message_Template_Group[] message template groups.
+	 */
+	public function get_all_trashed_grouped_message_templates(
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$global = true
+	) {
+		$_where                  = $global ? ['MTP_is_global' => true] : ['MTP_is_global' => false];
+		$_where['MTP_is_active'] = true;
+		$_where                  = $this->_maybe_mtp_filters($_where);
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count_deleted($query_params, 'GRP_ID', true) : $this->get_all_deleted($query_params);
+	}
+
+
+	/**
+	 * this returns the message template group(s) for a given event, messenger, and message template
+	 *
+	 * @param string              $messenger
+	 * @param string              $message_type
+	 * @param                     $evt_id
+	 * @param string              $orderby pointless at this point but still included
+	 * @param string              $order
+	 * @param mixed (array|null) $limit   array($offset, $num)
+	 * @param bool                $count   true = just return count, false = objects
+	 * @param bool                $active  ignore "active" or not. (default only return active)
+	 * @return \mixed[]) depending on $count.
+	 */
+	public function get_event_message_templates_by_m_and_mt_and_evt(
+		$messenger,
+		$message_type,
+		$evt_id,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'Event.EVT_ID'     => $evt_id,
+			'MTP_is_global'    => true,
+			'MTP_is_active'    => $active,
+		];
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all GLOBAL message template groups for the given messenger and message type
+	 *
+	 * @param string $messenger     slug for messenger
+	 * @param string $message_type  slug for message type
+	 * @param string $orderby       what column to orderby
+	 * @param string $order         ASC or DESC
+	 * @param mixed (array|null) $limit array($offset, $num)
+	 * @param bool   $count         true = just return count, false = objects
+	 * @param bool   $active        ignore "active" or not. (default only return active) -
+	 *                              'all' means return both inactive AND inactive.
+	 * @return array               message template objects that are global (i.e. non-event)
+	 */
+	public function get_global_message_template_by_m_and_mt(
+		$messenger,
+		$message_type,
+		$orderby = 'GRP_ID',
+		$order = 'ASC',
+		$limit = null,
+		$count = false,
+		$active = true
+	) {
+		$_where = [
+			'MTP_messenger'    => $messenger,
+			'MTP_message_type' => $message_type,
+			'MTP_is_global'    => true,
+		];
+
+		if ($active != 'all') {
+			$_where['MTP_is_active'] = $active;
+		}
+
+		$query_params = [$_where, 'order_by' => [$orderby => $order], 'limit' => $limit];
+
+		return $count ? $this->count($query_params, 'GRP_ID', true) : $this->get_all($query_params);
+	}
+
+
+	/**
+	 * get all custom message template groups for the given messenger and message type
+	 *
+	 * @param string $messenger    messenger
+	 * @param string $message_type messagetype
+	 * @param array  $query_params same as EEM_Base->get_all()
+	 * @return EE_Message_Template_Group[]
+	 */
+	public function get_custom_message_template_by_m_and_mt($messenger, $message_type, $query_params = [])
+	{
+		return $this->get_all(
+			array_merge(
+				$query_params,
+				[
+					[
+						'MTP_is_global'    => false,
+						'MTP_messenger'    => $messenger,
+						'MTP_message_type' => $message_type,
+					],
+				]
+			)
+		);
+	}
+
+
+	/**
+	 * This sends things to the validator for the given messenger and message type.
+	 *
+	 * @param array  $fields       the incoming fields to check.
+	 *                             Note this array is in the formatted fields from the form fields setup.
+	 *                             So we need to reformat this into an array of expected field refs by the validator.
+	 *                             Note also that this is not only the fields for the Message Template Group
+	 *                             but ALSO for Message Template.
+	 * @param string $context      The context the fields were obtained from.
+	 * @param string $messenger    The messenger we are validating
+	 * @param string $message_type The message type we are validating.
+	 * @return bool
+	 * @throws DomainException
+	 */
+	public function validate(array $fields, string $context, string $messenger, string $message_type): bool
+	{
+		/** @var MessageTemplateValidator $validator */
+		$validator = LoaderFactory::getShared(MessageTemplateValidator::class);
+		return $validator->validateTemplateFields($messenger, $message_type, $context, $fields);
+	}
+
+
+	/**
+	 * Updates all message template groups matching the incoming arguments to inactive status.
+	 *
+	 * @param array $messenger_names    The messenger slugs.
+	 *                                  If empty then all templates matching the message types are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @param array $message_type_names The message type slugs.
+	 *                                  If empty then all templates matching the messengers are marked inactive.
+	 *                                  Otherwise only templates matching the messengers and message types.
+	 * @return int  count of updated records.
+	 */
+	public function deactivate_message_template_groups_for($messenger_names = [], $message_type_names = [])
+	{
+		$query_args = [];
+		if (empty($messenger_names) && empty($message_type_names)) {
+			return 0;
+		}
+		if (! empty($messenger_names)) {
+			$query_args[0]['MTP_messenger'] = ['IN', (array) $messenger_names];
+		}
+		if (! empty($message_type_names)) {
+			$query_args[0]['MTP_message_type'] = ['IN', (array) $message_type_names];
+		}
+		return $this->update(['MTP_is_active' => false], $query_args);
+	}
 }

core/db_models/EEM_Form_Section.model.php

Indentation +231 added lines, -231 removed lines

@@ -20,235 +20,235 @@
  */
 class EEM_Form_Section extends EEM_Base
 {
-    public const APPLIES_TO_ALL         = 'all';
-
-    public const APPLIES_TO_PRIMARY     = 'primary';
-
-    public const APPLIES_TO_PURCHASER   = 'purchaser';
-
-    public const APPLIES_TO_REGISTRANTS = 'registrants';
-
-    protected static ?EEM_Form_Section $_instance = null;
-
-    private RequestInterface $request;
-
-    private array $valid_applies_to_options;
-
-
-    /**
-     * EEM_Form_Section constructor.
-     *
-     * @param FormStatus  $form_status
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(FormStatus $form_status, ?string $timezone = '')
-    {
-        $this->valid_applies_to_options = apply_filters(
-            'FHEE__EEM_Form_Section__valid_applies_to_options',
-            [
-                EEM_Form_Section::APPLIES_TO_ALL         => esc_html__('All Registrants', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_PRIMARY     => esc_html__('Primary Registrant Only', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_PURCHASER   => esc_html__('Purchasing Agent', 'event_espresso'),
-                EEM_Form_Section::APPLIES_TO_REGISTRANTS => esc_html__('Additional Registrants', 'event_espresso'),
-            ]
-        );
-
-        $this->singular_item = esc_html__('Form Section', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Sections', 'event_espresso');
-
-        $this->_tables          = [
-            'Form_Section' => new EE_Primary_Table('esp_form_section', 'FSC_UUID'),
-        ];
-        $this->_fields          = [
-            'Form_Section' => [
-                'FSC_UUID'       => new EE_Primary_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_appliesTo'  => new EE_Enum_Text_Field(
-                    'FSC_appliesTo',
-                    esc_html(
-                        sprintf(
-                        /* translators: 1 class name */
-                            __(
-                                'Form user type that this form section should be presented to. Values correspond to the %s constants.',
-                                'event_espresso'
-                            ),
-                            'EEM_Form_Section::APPLIES_TO_*'
-                        )
-                    ),
-                    false,
-                    EEM_Form_Section::APPLIES_TO_ALL,
-                    $this->valid_applies_to_options
-                ),
-                'FSC_attributes' => new EE_JSON_Field(
-                    'FSC_attributes',
-                    esc_html__(
-                        'JSON string of HTML attributes, such as class, to be applied to this form section\'s container.',
-                        'event_espresso'
-                    ),
-                    false,
-                    '{}'
-                ),
-                'FSC_belongsTo'  => new EE_Plain_Text_Field(
-                    'FSC_belongsTo',
-                    esc_html__('UUID of parent form section that this one belongs to.', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'FSC_label'      => new EE_JSON_Field(
-                    'FSC_label',
-                    esc_html__(
-                        'JSON string of properties pertaining to a form section\'s label.',
-                        'event_espresso'
-                    ),
-                    false,
-                    '{}'
-                ),
-                'FSC_order'      => new EE_Integer_Field(
-                    'FSC_order',
-                    esc_html__('Order in which form section appears in a form.', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'FSC_status'     => new EE_Enum_Text_Field(
-                    'FSC_status',
-                    esc_html(
-                        sprintf(
-                        /* translators: 1 class name */
-                            __(
-                                'Whether form section is active, archived, shared, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
-                                'event_espresso'
-                            ),
-                            'EventEspresso\core\services\form\meta\FormStatus'
-                        )
-                    ),
-                    false,
-                    FormStatus::ACTIVE,
-                    $form_status->validStatusOptions()
-                ),
-                'FSC_wpUser'     => new EE_WP_User_Field(
-                    'FSC_wpUser',
-                    esc_html__('ID of the WP User that created this form section.', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Form_Element'    => new EE_Has_Many_Relation(),
-            'Form_Submission' => new EE_Has_Many_Relation(),
-            'WP_User'         => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $restrictions                              = [];
-        $restrictions[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $restrictions[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $restrictions[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
-        $this->_cap_restriction_generators         = $restrictions;
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
-        $query_params['default_where_conditions'] = $admin_request
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
-
-
-    /**
-     * form sections should always be sorted in ascending order via the FSC_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FSC_order' => 'ASC'];
-        return $query_params;
-    }
-
-
-    /**
-     * returns an array of Form Sections that should be added by default to new Events
-     *
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     */
-    public function getDefaultFormSections(): array
-    {
-        return $this->getFormSections(['FSC_status' => FormStatus::DEFAULT]);
-    }
-
-
-    /**
-     * returns an array of Form Sections for the specified parent Form Section
-     *
-     * @param string $FSC_UUID
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     */
-    public function getChildFormSections(string $FSC_UUID): array
-    {
-        return $this->getFormSections(['FSC_belongsTo' => $FSC_UUID]);
-    }
-
-
-    /**
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     */
-    public function getFormSections(array $where_params): array
-    {
-        $query_params = $this->addDefaultWhereConditions([$where_params]);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * returns an array of Form Sections for the specified Event
-     *
-     * @param EE_Event $event
-     * @return EE_Form_Section[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getFormSectionsForEvent(EE_Event $event): array
-    {
-        $FSC_UUID = $event->registrationFormUuid();
-        return ! empty($FSC_UUID)
-            ? $this->getFormSections(
-                [
-                    'OR' => [
-                        'FSC_UUID'      => $FSC_UUID, // top level form
-                        'FSC_belongsTo' => $FSC_UUID, // child form sections
-                    ],
-                ]
-            )
-            : [];
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validAppliesToOptions(bool $constants_only = false): array
-    {
-        return $constants_only
-            ? array_keys($this->valid_applies_to_options)
-            : $this->valid_applies_to_options;
-    }
+	public const APPLIES_TO_ALL         = 'all';
+
+	public const APPLIES_TO_PRIMARY     = 'primary';
+
+	public const APPLIES_TO_PURCHASER   = 'purchaser';
+
+	public const APPLIES_TO_REGISTRANTS = 'registrants';
+
+	protected static ?EEM_Form_Section $_instance = null;
+
+	private RequestInterface $request;
+
+	private array $valid_applies_to_options;
+
+
+	/**
+	 * EEM_Form_Section constructor.
+	 *
+	 * @param FormStatus  $form_status
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(FormStatus $form_status, ?string $timezone = '')
+	{
+		$this->valid_applies_to_options = apply_filters(
+			'FHEE__EEM_Form_Section__valid_applies_to_options',
+			[
+				EEM_Form_Section::APPLIES_TO_ALL         => esc_html__('All Registrants', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_PRIMARY     => esc_html__('Primary Registrant Only', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_PURCHASER   => esc_html__('Purchasing Agent', 'event_espresso'),
+				EEM_Form_Section::APPLIES_TO_REGISTRANTS => esc_html__('Additional Registrants', 'event_espresso'),
+			]
+		);
+
+		$this->singular_item = esc_html__('Form Section', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Sections', 'event_espresso');
+
+		$this->_tables          = [
+			'Form_Section' => new EE_Primary_Table('esp_form_section', 'FSC_UUID'),
+		];
+		$this->_fields          = [
+			'Form_Section' => [
+				'FSC_UUID'       => new EE_Primary_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_appliesTo'  => new EE_Enum_Text_Field(
+					'FSC_appliesTo',
+					esc_html(
+						sprintf(
+						/* translators: 1 class name */
+							__(
+								'Form user type that this form section should be presented to. Values correspond to the %s constants.',
+								'event_espresso'
+							),
+							'EEM_Form_Section::APPLIES_TO_*'
+						)
+					),
+					false,
+					EEM_Form_Section::APPLIES_TO_ALL,
+					$this->valid_applies_to_options
+				),
+				'FSC_attributes' => new EE_JSON_Field(
+					'FSC_attributes',
+					esc_html__(
+						'JSON string of HTML attributes, such as class, to be applied to this form section\'s container.',
+						'event_espresso'
+					),
+					false,
+					'{}'
+				),
+				'FSC_belongsTo'  => new EE_Plain_Text_Field(
+					'FSC_belongsTo',
+					esc_html__('UUID of parent form section that this one belongs to.', 'event_espresso'),
+					false,
+					''
+				),
+				'FSC_label'      => new EE_JSON_Field(
+					'FSC_label',
+					esc_html__(
+						'JSON string of properties pertaining to a form section\'s label.',
+						'event_espresso'
+					),
+					false,
+					'{}'
+				),
+				'FSC_order'      => new EE_Integer_Field(
+					'FSC_order',
+					esc_html__('Order in which form section appears in a form.', 'event_espresso'),
+					false,
+					0
+				),
+				'FSC_status'     => new EE_Enum_Text_Field(
+					'FSC_status',
+					esc_html(
+						sprintf(
+						/* translators: 1 class name */
+							__(
+								'Whether form section is active, archived, shared, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
+								'event_espresso'
+							),
+							'EventEspresso\core\services\form\meta\FormStatus'
+						)
+					),
+					false,
+					FormStatus::ACTIVE,
+					$form_status->validStatusOptions()
+				),
+				'FSC_wpUser'     => new EE_WP_User_Field(
+					'FSC_wpUser',
+					esc_html__('ID of the WP User that created this form section.', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Form_Element'    => new EE_Has_Many_Relation(),
+			'Form_Submission' => new EE_Has_Many_Relation(),
+			'WP_User'         => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$restrictions                              = [];
+		$restrictions[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
+		$restrictions[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$restrictions[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$restrictions[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Reg_Form('FSC_applies_to');
+		$this->_cap_restriction_generators         = $restrictions;
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
+		$query_params['default_where_conditions'] = $admin_request
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
+
+
+	/**
+	 * form sections should always be sorted in ascending order via the FSC_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FSC_order' => 'ASC'];
+		return $query_params;
+	}
+
+
+	/**
+	 * returns an array of Form Sections that should be added by default to new Events
+	 *
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 */
+	public function getDefaultFormSections(): array
+	{
+		return $this->getFormSections(['FSC_status' => FormStatus::DEFAULT]);
+	}
+
+
+	/**
+	 * returns an array of Form Sections for the specified parent Form Section
+	 *
+	 * @param string $FSC_UUID
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 */
+	public function getChildFormSections(string $FSC_UUID): array
+	{
+		return $this->getFormSections(['FSC_belongsTo' => $FSC_UUID]);
+	}
+
+
+	/**
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 */
+	public function getFormSections(array $where_params): array
+	{
+		$query_params = $this->addDefaultWhereConditions([$where_params]);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * returns an array of Form Sections for the specified Event
+	 *
+	 * @param EE_Event $event
+	 * @return EE_Form_Section[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getFormSectionsForEvent(EE_Event $event): array
+	{
+		$FSC_UUID = $event->registrationFormUuid();
+		return ! empty($FSC_UUID)
+			? $this->getFormSections(
+				[
+					'OR' => [
+						'FSC_UUID'      => $FSC_UUID, // top level form
+						'FSC_belongsTo' => $FSC_UUID, // child form sections
+					],
+				]
+			)
+			: [];
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validAppliesToOptions(bool $constants_only = false): array
+	{
+		return $constants_only
+			? array_keys($this->valid_applies_to_options)
+			: $this->valid_applies_to_options;
+	}
 }

core/db_models/EEM_Datetime_Ticket.model.php

Indentation +51 added lines, -51 removed lines

@@ -10,58 +10,58 @@
  */
 class EEM_Datetime_Ticket extends EEM_Base
 {
-    protected static ?EEM_Datetime_Ticket $_instance = null;
+	protected static ?EEM_Datetime_Ticket $_instance = null;
 
 
-    /**
-     * @param string|null $timezone 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
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Datetime Ticket', 'event_espresso');
-        $this->plural_item   = esc_html__('Datetime Tickets', 'event_espresso');
+	/**
+	 * @param string|null $timezone 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
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Datetime Ticket', 'event_espresso');
+		$this->plural_item   = esc_html__('Datetime Tickets', 'event_espresso');
 
-        $this->_tables          = [
-            'Datetime_Ticket' => new EE_Primary_Table('esp_datetime_ticket', 'DTK_ID'),
-        ];
-        $this->_fields          = [
-            'Datetime_Ticket' => [
-                'DTK_ID' => new EE_Primary_Key_Int_Field('DTK_ID', esc_html__('Datetime Ticket ID', 'event_espresso')),
-                'DTT_ID' => new EE_Foreign_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('The ID to the Datetime', 'event_espresso'),
-                    false,
-                    0,
-                    'Datetime'
-                ),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('The ID to the Ticket', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Ticket'   => new EE_Belongs_To_Relation(),
-            'Datetime' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                                  = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
-        $this->model_chain_to_password                                  = $path_to_event;
-        parent::__construct($timezone);
-    }
+		$this->_tables          = [
+			'Datetime_Ticket' => new EE_Primary_Table('esp_datetime_ticket', 'DTK_ID'),
+		];
+		$this->_fields          = [
+			'Datetime_Ticket' => [
+				'DTK_ID' => new EE_Primary_Key_Int_Field('DTK_ID', esc_html__('Datetime Ticket ID', 'event_espresso')),
+				'DTT_ID' => new EE_Foreign_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('The ID to the Datetime', 'event_espresso'),
+					false,
+					0,
+					'Datetime'
+				),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('The ID to the Ticket', 'event_espresso'),
+					false,
+					0,
+					'Ticket'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Ticket'   => new EE_Belongs_To_Relation(),
+			'Datetime' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                                  = 'Datetime.Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected($path_to_event, EEM_Base::caps_edit);
+		$this->model_chain_to_password                                  = $path_to_event;
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Ticket.model.php

Indentation +481 added lines, -481 removed lines

@@ -13,485 +13,485 @@
  */
 class EEM_Ticket extends EEM_Soft_Delete_Base
 {
-    /**
-     * the following constants define where tickets can be viewed throughout the UI
-     *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
-     *  TICKET_VISIBILITY_PUBLIC        - basically displayed everywhere
-     *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged-in user
-     *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged-in user that is an admin
-     *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
-     */
-    public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
-
-    public const TICKET_VISIBILITY_NONE_VALUE          = 0;
-
-    public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
-
-    public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
-
-    public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
-
-    public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
-
-    public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
-
-
-    /**
-     * defines where tickets can be viewed throughout the UI
-     *
-     * @var array
-     */
-    private $ticket_visibility;
-
-    protected static ?EEM_Ticket $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone 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 ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket', 'event_espresso');
-        $this->plural_item   = esc_html__('Tickets', 'event_espresso');
-        $this->_tables       = [
-            'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
-        ];
-        $this->parseTicketVisibilityOptions();
-        $this->_fields          = [
-            'Ticket' => [
-                'TKT_ID'                => new EE_Primary_Key_Int_Field(
-                    'TKT_ID',
-                    esc_html__('Ticket ID', 'event_espresso')
-                ),
-                'TTM_ID'                => new EE_Foreign_Key_Int_Field(
-                    'TTM_ID',
-                    esc_html__('Ticket Template ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Ticket_Template'
-                ),
-                'TKT_name'              => new EE_Plain_Text_Field(
-                    'TKT_name',
-                    esc_html__('Ticket Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_description'       => new EE_Post_Content_Field(
-                    'TKT_description',
-                    esc_html__('Description of Ticket', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'TKT_start_date'        => new EE_Datetime_Field(
-                    'TKT_start_date',
-                    esc_html__('Start time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_end_date'          => new EE_Datetime_Field(
-                    'TKT_end_date',
-                    esc_html__('End time/date of Ticket', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'TKT_min'               => new EE_Integer_Field(
-                    'TKT_min',
-                    esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_max'               => new EE_Infinite_Integer_Field(
-                    'TKT_max',
-                    esc_html__(
-                        'Maximum quantity of this ticket that can be purchased in one transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_INF
-                ),
-                'TKT_price'             => new EE_Money_Field(
-                    'TKT_price',
-                    esc_html__('Final calculated price for ticket', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_sold'              => new EE_Integer_Field(
-                    'TKT_sold',
-                    esc_html__('Number of this ticket sold', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_qty'               => new EE_Infinite_Integer_Field(
-                    'TKT_qty',
-                    esc_html__('Quantity of this ticket that is available', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_reserved'          => new EE_Integer_Field(
-                    'TKT_reserved',
-                    esc_html__(
-                        'Quantity of this ticket that is reserved, but not yet fully purchased',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_uses'              => new EE_Infinite_Integer_Field(
-                    'TKT_uses',
-                    esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'TKT_required'          => new EE_Boolean_Field(
-                    'TKT_required',
-                    esc_html__(
-                        'Flag indicating whether this ticket must be purchased with a transaction',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_taxable'           => new EE_Boolean_Field(
-                    'TKT_taxable',
-                    esc_html__(
-                        'Flag indicating whether there is tax applied on this ticket',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_is_default'        => new EE_Boolean_Field(
-                    'TKT_is_default',
-                    esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_order'             => new EE_Integer_Field(
-                    'TKT_order',
-                    esc_html__(
-                        'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'TKT_row'               => new EE_Integer_Field(
-                    'TKT_row',
-                    esc_html__('How tickets are displayed in the ui', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'TKT_deleted'           => new EE_Trashed_Flag_Field(
-                    'TKT_deleted',
-                    esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'TKT_wp_user'           => new EE_WP_User_Field(
-                    'TKT_wp_user',
-                    esc_html__('Ticket Creator ID', 'event_espresso'),
-                    false
-                ),
-                'TKT_parent'            => new EE_Integer_Field(
-                    'TKT_parent',
-                    esc_html__(
-                        'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
-                        'event_espresso'
-                    ),
-                    true,
-                    0
-                ),
-                'TKT_reverse_calculate' => new EE_Boolean_Field(
-                    'TKT_reverse_calculate',
-                    esc_html__(
-                        'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'TKT_visibility'        => new EE_Enum_Integer_Field(
-                    'TKT_visibility',
-                    esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
-                    false,
-                    EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                    $this->getTicketVisibilityEnumOptions()
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
-            'Datetime_Ticket' => new EE_Has_Many_Relation(),
-            'Price'           => new EE_HABTM_Relation('Ticket_Price'),
-            'Ticket_Template' => new EE_Belongs_To_Relation(),
-            'Registration'    => new EE_Has_Many_Relation(),
-            'WP_User'         => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                            = 'Datetime.Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
-            'TKT_is_default',
-            $path_to_event
-        );
-
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
-                                                                    = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
-            'TKT_is_default',
-            $path_to_event
-        );
-        $this->model_chain_to_password                              = $path_to_event;
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * This returns all tickets that are defaults from the db
-     *
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_default_tickets(): array
-    {
-        $tickets = $this->get_all(
-            [
-                [
-                    'TKT_is_default' => 1,
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-                'order_by' => ['TKT_ID' => 'ASC'],
-            ]
-        );
-        // we need to set the start date and end date to today's date and the start of the default dtt
-        return $this->_set_default_dates($tickets);
-    }
-
-
-    /**
-     * sets up relevant start and end date for EE_Ticket (s)
-     *
-     * @param EE_Ticket[] $tickets
-     * @return EE_Ticket[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    private function _set_default_dates(array $tickets): array
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->set(
-                'TKT_start_date',
-                (int) $this->current_time_for_query('TKT_start_date', true)
-            );
-            $ticket->set(
-                'TKT_end_date',
-                (int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
-            );
-            $ticket->set_end_time(
-                $this->convert_datetime_for_query(
-                    'TKT_end_date',
-                    '11:59 pm',
-                    'g:i a',
-                    $this->_timezone
-                )
-            );
-        }
-        return $tickets;
-    }
-
-
-    /**
-     * Gets the total number of tickets available at a particular datetime (does
-     * NOT take int account the datetime's spaces available)
-     *
-     * @param int   $DTT_ID
-     * @param array $query_params
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
-    {
-        $query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
-        return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
-    }
-
-
-    /**
-     * Updates the TKT_sold quantity on all the tickets matching $query_params
-     *
-     * @param EE_Ticket[] $tickets
-     * @return void
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function update_tickets_sold(array $tickets)
-    {
-        foreach ($tickets as $ticket) {
-            $ticket->update_tickets_sold();
-        }
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
-     *
-     * @return EE_Base_Class[]|EE_Ticket[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_reservations(): ?array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_reserved'   => ['>', 0],
-                    'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * returns an array of EE_Ticket objects matching the supplied list of IDs
-     *
-     * @param array $ticket_IDs
-     * @return EE_Base_Class[]|EE_Ticket[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_tickets_with_IDs(array $ticket_IDs): ?array
-    {
-        return $this->get_all(
-            [
-                [
-                    'TKT_ID' => ['IN', $ticket_IDs],
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return void
-     */
-    private function parseTicketVisibilityOptions()
-    {
-        $this->ticket_visibility = (array) apply_filters(
-            'FHEE__EEM_Ticket__construct__ticket_visibility',
-            [
-                EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
-                    'desc'  => esc_html__('ticket displayed to everyone everywhere', 'event_espresso'),
-                    'label' => esc_html__('Public', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
-                    'desc'  => esc_html__('ticket only displayed to logged-in users', 'event_espresso'),
-                    'label' => esc_html__('Members only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
-                    'desc'  => esc_html__('ticket only displayed to logged-in admins', 'event_espresso'),
-                    'label' => esc_html__('Admins only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
-                    'desc'  => esc_html__(
-                        'ticket only displayed in the admin UI and not on the frontend',
-                        'event_espresso'
-                    ),
-                    'label' => esc_html__('Admin UI only', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
-                ],
-                EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
-                    'desc'  => esc_html__('will hide the ticket everywhere', 'event_espresso'),
-                    'label' => esc_html__('None', 'event_espresso'),
-                    'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
-                ],
-            ]
-        );
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityEnumOptions(): array
-    {
-        $ticket_visibility = [];
-        foreach ($this->ticket_visibility as $visibility) {
-            if (isset($visibility['value'], $visibility['label'])) {
-                $ticket_visibility[ $visibility['value'] ] = $visibility['label'];
-            }
-        }
-        return $ticket_visibility;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityValues(): array
-    {
-        // copy ticket_visibility array
-        $ticket_visibility_options = $this->ticket_visibility;
-        foreach ($ticket_visibility_options as $ticket_visibility_option) {
-            // remove labels because we only want the values
-            unset($ticket_visibility_option['label']);
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function getTicketVisibilityLabels(): array
-    {
-        $ticket_visibility_options = [];
-        foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
-            if (isset($ticket_visibility_option['label'])) {
-                // change because we only want the labels tied to the keys
-                $ticket_visibility_options[] = [
-                    'value' => $key,
-                    'label' => $ticket_visibility_option['label'],
-                ];
-            }
-        }
-        return $ticket_visibility_options;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function ticketVisibilityOptions(): array
-    {
-        return $this->ticket_visibility;
-    }
+	/**
+	 * the following constants define where tickets can be viewed throughout the UI
+	 *  TICKET_VISIBILITY_NONE          - will not be displayed anywhere
+	 *  TICKET_VISIBILITY_PUBLIC        - basically displayed everywhere
+	 *  TICKET_VISIBILITY_MEMBERS_ONLY  - displayed to any logged-in user
+	 *  TICKET_VISIBILITY_ADMINS_ONLY   - displayed to any logged-in user that is an admin
+	 *  TICKET_VISIBILITY_ADMIN_UI_ONLY - only displayed in the admin, never publicly
+	 */
+	public const TICKET_VISIBILITY_NONE_KEY            = 'NONE';
+
+	public const TICKET_VISIBILITY_NONE_VALUE          = 0;
+
+	public const TICKET_VISIBILITY_PUBLIC_KEY          = 'PUBLIC';
+
+	public const TICKET_VISIBILITY_PUBLIC_VALUE        = 100;
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_KEY    = 'MEMBERS_ONLY';
+
+	public const TICKET_VISIBILITY_MEMBERS_ONLY_VALUE  = 200;
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_KEY     = 'ADMINS_ONLY';
+
+	public const TICKET_VISIBILITY_ADMINS_ONLY_VALUE   = 300;
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY   = 'ADMIN_UI_ONLY';
+
+	public const TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE = 400;
+
+
+	/**
+	 * defines where tickets can be viewed throughout the UI
+	 *
+	 * @var array
+	 */
+	private $ticket_visibility;
+
+	protected static ?EEM_Ticket $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone 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 ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket', 'event_espresso');
+		$this->plural_item   = esc_html__('Tickets', 'event_espresso');
+		$this->_tables       = [
+			'Ticket' => new EE_Primary_Table('esp_ticket', 'TKT_ID'),
+		];
+		$this->parseTicketVisibilityOptions();
+		$this->_fields          = [
+			'Ticket' => [
+				'TKT_ID'                => new EE_Primary_Key_Int_Field(
+					'TKT_ID',
+					esc_html__('Ticket ID', 'event_espresso')
+				),
+				'TTM_ID'                => new EE_Foreign_Key_Int_Field(
+					'TTM_ID',
+					esc_html__('Ticket Template ID', 'event_espresso'),
+					false,
+					0,
+					'Ticket_Template'
+				),
+				'TKT_name'              => new EE_Plain_Text_Field(
+					'TKT_name',
+					esc_html__('Ticket Name', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_description'       => new EE_Post_Content_Field(
+					'TKT_description',
+					esc_html__('Description of Ticket', 'event_espresso'),
+					false,
+					''
+				),
+				'TKT_start_date'        => new EE_Datetime_Field(
+					'TKT_start_date',
+					esc_html__('Start time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_end_date'          => new EE_Datetime_Field(
+					'TKT_end_date',
+					esc_html__('End time/date of Ticket', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'TKT_min'               => new EE_Integer_Field(
+					'TKT_min',
+					esc_html__('Minimum quantity of this ticket that must be purchased', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_max'               => new EE_Infinite_Integer_Field(
+					'TKT_max',
+					esc_html__(
+						'Maximum quantity of this ticket that can be purchased in one transaction',
+						'event_espresso'
+					),
+					false,
+					EE_INF
+				),
+				'TKT_price'             => new EE_Money_Field(
+					'TKT_price',
+					esc_html__('Final calculated price for ticket', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_sold'              => new EE_Integer_Field(
+					'TKT_sold',
+					esc_html__('Number of this ticket sold', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_qty'               => new EE_Infinite_Integer_Field(
+					'TKT_qty',
+					esc_html__('Quantity of this ticket that is available', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_reserved'          => new EE_Integer_Field(
+					'TKT_reserved',
+					esc_html__(
+						'Quantity of this ticket that is reserved, but not yet fully purchased',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_uses'              => new EE_Infinite_Integer_Field(
+					'TKT_uses',
+					esc_html__('Number of datetimes this ticket can be used at', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'TKT_required'          => new EE_Boolean_Field(
+					'TKT_required',
+					esc_html__(
+						'Flag indicating whether this ticket must be purchased with a transaction',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_taxable'           => new EE_Boolean_Field(
+					'TKT_taxable',
+					esc_html__(
+						'Flag indicating whether there is tax applied on this ticket',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_is_default'        => new EE_Boolean_Field(
+					'TKT_is_default',
+					esc_html__('Flag indicating that this ticket is a default ticket', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_order'             => new EE_Integer_Field(
+					'TKT_order',
+					esc_html__(
+						'The order in which the Ticket is displayed in the editor (used for autosaves when the form doesn\'t have the ticket ID yet)',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'TKT_row'               => new EE_Integer_Field(
+					'TKT_row',
+					esc_html__('How tickets are displayed in the ui', 'event_espresso'),
+					false,
+					0
+				),
+				'TKT_deleted'           => new EE_Trashed_Flag_Field(
+					'TKT_deleted',
+					esc_html__('Flag indicating if this has been archived or not', 'event_espresso'),
+					false,
+					false
+				),
+				'TKT_wp_user'           => new EE_WP_User_Field(
+					'TKT_wp_user',
+					esc_html__('Ticket Creator ID', 'event_espresso'),
+					false
+				),
+				'TKT_parent'            => new EE_Integer_Field(
+					'TKT_parent',
+					esc_html__(
+						'Indicates what TKT_ID is the parent of this TKT_ID (used in autosaves/revisions)',
+						'event_espresso'
+					),
+					true,
+					0
+				),
+				'TKT_reverse_calculate' => new EE_Boolean_Field(
+					'TKT_reverse_calculate',
+					esc_html__(
+						'Flag indicating whether ticket calculations should run in reverse and calculate the base ticket price from the provided ticket total.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'TKT_visibility'        => new EE_Enum_Integer_Field(
+					'TKT_visibility',
+					esc_html__('Defines where the ticket can be viewed throughout the UI.', 'event_espresso'),
+					false,
+					EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+					$this->getTicketVisibilityEnumOptions()
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Datetime'        => new EE_HABTM_Relation('Datetime_Ticket'),
+			'Datetime_Ticket' => new EE_Has_Many_Relation(),
+			'Price'           => new EE_HABTM_Relation('Ticket_Price'),
+			'Ticket_Template' => new EE_Belongs_To_Relation(),
+			'Registration'    => new EE_Has_Many_Relation(),
+			'WP_User'         => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                            = 'Datetime.Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Default_Public(
+			'TKT_is_default',
+			$path_to_event
+		);
+
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ]
+																	= new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]   = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Default_Protected(
+			'TKT_is_default',
+			$path_to_event
+		);
+		$this->model_chain_to_password                              = $path_to_event;
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * This returns all tickets that are defaults from the db
+	 *
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_default_tickets(): array
+	{
+		$tickets = $this->get_all(
+			[
+				[
+					'TKT_is_default' => 1,
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+				'order_by' => ['TKT_ID' => 'ASC'],
+			]
+		);
+		// we need to set the start date and end date to today's date and the start of the default dtt
+		return $this->_set_default_dates($tickets);
+	}
+
+
+	/**
+	 * sets up relevant start and end date for EE_Ticket (s)
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return EE_Ticket[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	private function _set_default_dates(array $tickets): array
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->set(
+				'TKT_start_date',
+				(int) $this->current_time_for_query('TKT_start_date', true)
+			);
+			$ticket->set(
+				'TKT_end_date',
+				(int) $this->current_time_for_query('TKT_end_date', true) + MONTH_IN_SECONDS
+			);
+			$ticket->set_end_time(
+				$this->convert_datetime_for_query(
+					'TKT_end_date',
+					'11:59 pm',
+					'g:i a',
+					$this->_timezone
+				)
+			);
+		}
+		return $tickets;
+	}
+
+
+	/**
+	 * Gets the total number of tickets available at a particular datetime (does
+	 * NOT take int account the datetime's spaces available)
+	 *
+	 * @param int   $DTT_ID
+	 * @param array $query_params
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function sum_tickets_currently_available_at_datetime(int $DTT_ID, array $query_params = []): int
+	{
+		$query_params += [['TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE]]];
+		return EEM_Datetime::instance()->sum_tickets_currently_available_at_datetime($DTT_ID, $query_params);
+	}
+
+
+	/**
+	 * Updates the TKT_sold quantity on all the tickets matching $query_params
+	 *
+	 * @param EE_Ticket[] $tickets
+	 * @return void
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function update_tickets_sold(array $tickets)
+	{
+		foreach ($tickets as $ticket) {
+			$ticket->update_tickets_sold();
+		}
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects with a non-zero value for TKT_reserved
+	 *
+	 * @return EE_Base_Class[]|EE_Ticket[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_reservations(): ?array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_reserved'   => ['>', 0],
+					'TKT_visibility' => ['>', EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * returns an array of EE_Ticket objects matching the supplied list of IDs
+	 *
+	 * @param array $ticket_IDs
+	 * @return EE_Base_Class[]|EE_Ticket[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_tickets_with_IDs(array $ticket_IDs): ?array
+	{
+		return $this->get_all(
+			[
+				[
+					'TKT_ID' => ['IN', $ticket_IDs],
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return void
+	 */
+	private function parseTicketVisibilityOptions()
+	{
+		$this->ticket_visibility = (array) apply_filters(
+			'FHEE__EEM_Ticket__construct__ticket_visibility',
+			[
+				EEM_Ticket::TICKET_VISIBILITY_PUBLIC_KEY        => [
+					'desc'  => esc_html__('ticket displayed to everyone everywhere', 'event_espresso'),
+					'label' => esc_html__('Public', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_PUBLIC_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_KEY  => [
+					'desc'  => esc_html__('ticket only displayed to logged-in users', 'event_espresso'),
+					'label' => esc_html__('Members only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_MEMBERS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_KEY   => [
+					'desc'  => esc_html__('ticket only displayed to logged-in admins', 'event_espresso'),
+					'label' => esc_html__('Admins only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMINS_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_KEY => [
+					'desc'  => esc_html__(
+						'ticket only displayed in the admin UI and not on the frontend',
+						'event_espresso'
+					),
+					'label' => esc_html__('Admin UI only', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_ADMIN_UI_ONLY_VALUE,
+				],
+				EEM_Ticket::TICKET_VISIBILITY_NONE_KEY          => [
+					'desc'  => esc_html__('will hide the ticket everywhere', 'event_espresso'),
+					'label' => esc_html__('None', 'event_espresso'),
+					'value' => EEM_Ticket::TICKET_VISIBILITY_NONE_VALUE,
+				],
+			]
+		);
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityEnumOptions(): array
+	{
+		$ticket_visibility = [];
+		foreach ($this->ticket_visibility as $visibility) {
+			if (isset($visibility['value'], $visibility['label'])) {
+				$ticket_visibility[ $visibility['value'] ] = $visibility['label'];
+			}
+		}
+		return $ticket_visibility;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityValues(): array
+	{
+		// copy ticket_visibility array
+		$ticket_visibility_options = $this->ticket_visibility;
+		foreach ($ticket_visibility_options as $ticket_visibility_option) {
+			// remove labels because we only want the values
+			unset($ticket_visibility_option['label']);
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function getTicketVisibilityLabels(): array
+	{
+		$ticket_visibility_options = [];
+		foreach ($this->ticket_visibility as $key => $ticket_visibility_option) {
+			if (isset($ticket_visibility_option['label'])) {
+				// change because we only want the labels tied to the keys
+				$ticket_visibility_options[] = [
+					'value' => $key,
+					'label' => $ticket_visibility_option['label'],
+				];
+			}
+		}
+		return $ticket_visibility_options;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function ticketVisibilityOptions(): array
+	{
+		return $this->ticket_visibility;
+	}
 }

core/db_models/EEM_Answer.model.php

Indentation +179 added lines, -179 removed lines

@@ -9,192 +9,192 @@
  */
 class EEM_Answer extends EEM_Base
 {
-    protected static ?EEM_Answer $_instance = null;
+	protected static ?EEM_Answer $_instance = null;
 
-    /**
-     * Mapping from system question ids to attendee field names
-     *
-     * @type array
-     * @deprecated since version 4.8.8
-     */
-    protected $_question_id_to_att_field_map = [
-        EEM_Attendee::fname_question_id    => 'ATT_fname',
-        EEM_Attendee::lname_question_id    => 'ATT_lname',
-        EEM_Attendee::email_question_id    => 'ATT_email',
-        EEM_Attendee::address_question_id  => 'ATT_address',
-        EEM_Attendee::address2_question_id => 'ATT_address2',
-        EEM_Attendee::city_question_id     => 'ATT_city',
-        EEM_Attendee::state_question_id    => 'STA_ID',
-        EEM_Attendee::country_question_id  => 'CNT_ISO',
-        EEM_Attendee::zip_question_id      => 'ATT_zip',
-        EEM_Attendee::phone_question_id    => 'ATT_phone',
-    ];
+	/**
+	 * Mapping from system question ids to attendee field names
+	 *
+	 * @type array
+	 * @deprecated since version 4.8.8
+	 */
+	protected $_question_id_to_att_field_map = [
+		EEM_Attendee::fname_question_id    => 'ATT_fname',
+		EEM_Attendee::lname_question_id    => 'ATT_lname',
+		EEM_Attendee::email_question_id    => 'ATT_email',
+		EEM_Attendee::address_question_id  => 'ATT_address',
+		EEM_Attendee::address2_question_id => 'ATT_address2',
+		EEM_Attendee::city_question_id     => 'ATT_city',
+		EEM_Attendee::state_question_id    => 'STA_ID',
+		EEM_Attendee::country_question_id  => 'CNT_ISO',
+		EEM_Attendee::zip_question_id      => 'ATT_zip',
+		EEM_Attendee::phone_question_id    => 'ATT_phone',
+	];
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item           = esc_html__('Answer', 'event_espresso');
-        $this->plural_item             = esc_html__('Answers', 'event_espresso');
-        $this->_tables                 = [
-            'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID'),
-        ];
-        $this->_fields                 = [
-            'Answer' => [
-                'ANS_ID'    => new EE_Primary_Key_Int_Field('ANS_ID', esc_html__('Answer ID', 'event_espresso')),
-                'REG_ID'    => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'QST_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field(
-                    'ANS_value',
-                    esc_html__('Answer Value', 'event_espresso'),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Question'     => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        $this->_caps_slug              = 'registrations';
-        parent::__construct($timezone);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item           = esc_html__('Answer', 'event_espresso');
+		$this->plural_item             = esc_html__('Answers', 'event_espresso');
+		$this->_tables                 = [
+			'Answer' => new EE_Primary_Table('esp_answer', 'ANS_ID'),
+		];
+		$this->_fields                 = [
+			'Answer' => [
+				'ANS_ID'    => new EE_Primary_Key_Int_Field('ANS_ID', esc_html__('Answer ID', 'event_espresso')),
+				'REG_ID'    => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration ID', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'QST_ID'    => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'ANS_value' => new EE_Maybe_Serialized_Simple_HTML_Field(
+					'ANS_value',
+					esc_html__('Answer Value', 'event_espresso'),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Question'     => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		$this->_caps_slug              = 'registrations';
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Gets the string answer to the question for this registration (it could either be stored
-     * on the attendee or in the answer table. This function finds its value regardless)
-     *
-     * @param EE_Registration $registration
-     * @param int             $question_id
-     * @param boolean         $pretty_answer whether to call 'pretty_value' or just 'value'
-     * @return string
-     */
-    public function get_answer_value_to_question(
-        EE_Registration $registration,
-        $question_id = null,
-        $pretty_answer = false
-    ) {
-        $value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
-        if ($value === null) {
-            $answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
-            if ($answer_obj instanceof EE_Answer) {
-                if ($pretty_answer) {
-                    $value = $answer_obj->pretty_value();
-                } else {
-                    $value = $answer_obj->value();
-                }
-            }
-        }
-        return apply_filters(
-            'FHEE__EEM_Answer__get_answer_value_to_question__answer_value',
-            $value,
-            $registration,
-            $question_id
-        );
-    }
+	/**
+	 * Gets the string answer to the question for this registration (it could either be stored
+	 * on the attendee or in the answer table. This function finds its value regardless)
+	 *
+	 * @param EE_Registration $registration
+	 * @param int             $question_id
+	 * @param boolean         $pretty_answer whether to call 'pretty_value' or just 'value'
+	 * @return string
+	 */
+	public function get_answer_value_to_question(
+		EE_Registration $registration,
+		$question_id = null,
+		$pretty_answer = false
+	) {
+		$value = $this->get_attendee_property_answer_value($registration, $question_id, $pretty_answer);
+		if ($value === null) {
+			$answer_obj = $this->get_registration_question_answer_object($registration, $question_id);
+			if ($answer_obj instanceof EE_Answer) {
+				if ($pretty_answer) {
+					$value = $answer_obj->pretty_value();
+				} else {
+					$value = $answer_obj->value();
+				}
+			}
+		}
+		return apply_filters(
+			'FHEE__EEM_Answer__get_answer_value_to_question__answer_value',
+			$value,
+			$registration,
+			$question_id
+		);
+	}
 
 
-    /**
-     * Gets the EE_Answer object for the question for this registration (if it exists)
-     *
-     * @param EE_Registration $registration
-     * @param int             $question_id
-     * @return EE_Answer
-     */
-    public function get_registration_question_answer_object(EE_Registration $registration, $question_id = null)
-    {
-        $answer_obj = $this->get_one([['QST_ID' => $question_id, 'REG_ID' => $registration->ID()]]);
-        return apply_filters(
-            'FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj',
-            $answer_obj,
-            $registration,
-            $question_id
-        );
-    }
+	/**
+	 * Gets the EE_Answer object for the question for this registration (if it exists)
+	 *
+	 * @param EE_Registration $registration
+	 * @param int             $question_id
+	 * @return EE_Answer
+	 */
+	public function get_registration_question_answer_object(EE_Registration $registration, $question_id = null)
+	{
+		$answer_obj = $this->get_one([['QST_ID' => $question_id, 'REG_ID' => $registration->ID()]]);
+		return apply_filters(
+			'FHEE__EEM_Answer__get_registration_question_answer_object__answer_obj',
+			$answer_obj,
+			$registration,
+			$question_id
+		);
+	}
 
 
-    /**
-     * Gets the string answer to the question for this registration's attendee
-     *
-     * @param EE_Registration $registration
-     * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
-     *                                            then it should be its QST_system value. Passing in the QST_system
-     *                                            value is more efficient
-     * @param boolean         $pretty_answer
-     * @return string|null (if the registration has no attendee, or the question_system_id is not a QST_ID or
-     *                                            QST_system for a question corresponding to an attendee field, returns
-     *                                            null)
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_attendee_property_answer_value(
-        EE_Registration $registration,
-        $question_system_id = null,
-        $pretty_answer = false
-    ) {
-        $value = null;
-        // backward compat: we still want to find the question's ID
-        if (is_numeric($question_system_id)) {
-            // find this question's QST_system value
-            $question_id        = $question_system_id;
-            $question_system_id = EEM_Question::instance()->get_var([['QST_ID' => $question_system_id]], 'QST_system');
-        } else {
-            $question_id = (int) EEM_Question::instance()->get_var([['QST_system' => $question_system_id]], 'QST_ID');
-        }
-        // only bother checking if the registration has an attendee
-        if ($registration->attendee() instanceof EE_Attendee) {
-            $field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
-            if ($field_name) {
-                if ($pretty_answer) {
-                    if ($field_name === 'STA_ID') {
-                        $state = $registration->attendee()->state_obj();
-                        $value = $state instanceof EE_State
-                            ? $state->name()
-                            : sprintf(
-                                esc_html__('Unknown State (%s)', 'event_espresso'),
-                                $registration->attendee()->state_ID()
-                            );
-                    } elseif ($field_name === 'CNT_ISO') {
-                        $country = $registration->attendee()->country_obj();
-                        $value   = $country instanceof EE_Country
-                            ? $country->name()
-                            : sprintf(
-                                esc_html__('Unknown Country (%s)', "event_espresso"),
-                                $registration->attendee()->country_ID()
-                            );
-                    } else {
-                        $value = $registration->attendee()->get_pretty($field_name);
-                    }
-                    // if field name is blank, leave the value as null too
-                } else {
-                    $value = $registration->attendee()->get($field_name);
-                }
-            }
-            // if no field was found, leave value blank
-        }
-        return apply_filters(
-            'FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value',
-            $value,
-            $registration,
-            $question_id,
-            $question_system_id
-        );
-    }
+	/**
+	 * Gets the string answer to the question for this registration's attendee
+	 *
+	 * @param EE_Registration $registration
+	 * @param int|string      $question_system_id if an INT this is understood to be the question's ID; if a string
+	 *                                            then it should be its QST_system value. Passing in the QST_system
+	 *                                            value is more efficient
+	 * @param boolean         $pretty_answer
+	 * @return string|null (if the registration has no attendee, or the question_system_id is not a QST_ID or
+	 *                                            QST_system for a question corresponding to an attendee field, returns
+	 *                                            null)
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_attendee_property_answer_value(
+		EE_Registration $registration,
+		$question_system_id = null,
+		$pretty_answer = false
+	) {
+		$value = null;
+		// backward compat: we still want to find the question's ID
+		if (is_numeric($question_system_id)) {
+			// find this question's QST_system value
+			$question_id        = $question_system_id;
+			$question_system_id = EEM_Question::instance()->get_var([['QST_ID' => $question_system_id]], 'QST_system');
+		} else {
+			$question_id = (int) EEM_Question::instance()->get_var([['QST_system' => $question_system_id]], 'QST_ID');
+		}
+		// only bother checking if the registration has an attendee
+		if ($registration->attendee() instanceof EE_Attendee) {
+			$field_name = EEM_Attendee::instance()->get_attendee_field_for_system_question($question_system_id);
+			if ($field_name) {
+				if ($pretty_answer) {
+					if ($field_name === 'STA_ID') {
+						$state = $registration->attendee()->state_obj();
+						$value = $state instanceof EE_State
+							? $state->name()
+							: sprintf(
+								esc_html__('Unknown State (%s)', 'event_espresso'),
+								$registration->attendee()->state_ID()
+							);
+					} elseif ($field_name === 'CNT_ISO') {
+						$country = $registration->attendee()->country_obj();
+						$value   = $country instanceof EE_Country
+							? $country->name()
+							: sprintf(
+								esc_html__('Unknown Country (%s)', "event_espresso"),
+								$registration->attendee()->country_ID()
+							);
+					} else {
+						$value = $registration->attendee()->get_pretty($field_name);
+					}
+					// if field name is blank, leave the value as null too
+				} else {
+					$value = $registration->attendee()->get($field_name);
+				}
+			}
+			// if no field was found, leave value blank
+		}
+		return apply_filters(
+			'FHEE__EEM_Answer__get_attendee_question_answer_value__answer_value',
+			$value,
+			$registration,
+			$question_id,
+			$question_system_id
+		);
+	}
 }

core/db_models/EEM_Question_Group_Question.model.php

Indentation +58 added lines, -58 removed lines

@@ -13,67 +13,67 @@
  */
 class EEM_Question_Group_Question extends EEM_Base
 {
-    protected static ?EEM_Question_Group_Question $_instance = null;
+	protected static ?EEM_Question_Group_Question $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
-        $this->_tables          = [
-            'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Group_Question' => [
-                'QGQ_ID'    => new EE_Primary_Key_Int_Field(
-                    'QGQ_ID',
-                    esc_html__('Question Group to Question Link ID', 'event_espresso')
-                ),
-                'QSG_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'QST_ID'    => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QGQ_order' => new EE_Integer_Field(
-                    'QGQ_order',
-                    esc_html__('Question Group Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question_Group' => new EE_Belongs_To_Relation(),
-            'Question'       => new EE_Belongs_To_Relation(),
-        ];
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Question Group to Question Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Question Group to Question Links', 'event_espresso');
+		$this->_tables          = [
+			'Question_Group_Question' => new EE_Primary_Table('esp_question_group_question', 'QGQ_ID'),
+		];
+		$this->_fields          = [
+			'Question_Group_Question' => [
+				'QGQ_ID'    => new EE_Primary_Key_Int_Field(
+					'QGQ_ID',
+					esc_html__('Question Group to Question Link ID', 'event_espresso')
+				),
+				'QSG_ID'    => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group ID', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'QST_ID'    => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question Id', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QGQ_order' => new EE_Integer_Field(
+					'QGQ_order',
+					esc_html__('Question Group Question Order', 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question_Group' => new EE_Belongs_To_Relation(),
+			'Question'       => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_model_chain_to_wp_user = 'Question_Group';
+		$this->_model_chain_to_wp_user = 'Question_Group';
 
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Public();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('Question_Group.QSG_system');
 
-        // use the caps for question groups
-        $this->_caps_slug = 'question_groups';
-        parent::__construct($timezone);
-    }
+		// use the caps for question groups
+		$this->_caps_slug = 'question_groups';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Extra_Meta.model.php

Indentation +51 added lines, -51 removed lines

@@ -14,58 +14,58 @@
  */
 class EEM_Extra_Meta extends EEM_Base
 {
-    protected static ?EEM_Extra_Meta $_instance = null;
+	protected static ?EEM_Extra_Meta $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item       = esc_html__('Extra Meta', 'event_espresso');
-        $this->plural_item         = esc_html__('Extra Metas', 'event_espresso');
-        $this->_tables             = [
-            'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_fields             = [
-            'Extra_Meta' => [
-                'EXM_ID'    => new EE_Primary_Key_Int_Field('EXM_ID', esc_html__("Extra Meta ID", "event_espresso")),
-                'OBJ_ID'    => new EE_Foreign_Key_Int_Field(
-                    'OBJ_ID',
-                    esc_html__("Primary Key of Attached Thing", "event_espresso"),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'EXM_type'  => new EE_Any_Foreign_Model_Name_Field(
-                    'EXM_type',
-                    esc_html__(
-                        "Model of Attached Thing",
-                        "event_espresso"
-                    ),
-                    false,
-                    'Transaction',
-                    $models_this_can_attach_to
-                ),
-                'EXM_key'   => new EE_Plain_Text_Field('EXM_key', esc_html__("Meta Key", "event_espresso"), false, ''),
-                'EXM_value' => new EE_Maybe_Serialized_Text_Field(
-                    'EXM_value',
-                    esc_html__("Meta Value", "event_espresso"),
-                    true
-                ),
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item       = esc_html__('Extra Meta', 'event_espresso');
+		$this->plural_item         = esc_html__('Extra Metas', 'event_espresso');
+		$this->_tables             = [
+			'Extra_Meta' => new EE_Primary_Table('esp_extra_meta', 'EXM_ID'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_fields             = [
+			'Extra_Meta' => [
+				'EXM_ID'    => new EE_Primary_Key_Int_Field('EXM_ID', esc_html__("Extra Meta ID", "event_espresso")),
+				'OBJ_ID'    => new EE_Foreign_Key_Int_Field(
+					'OBJ_ID',
+					esc_html__("Primary Key of Attached Thing", "event_espresso"),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'EXM_type'  => new EE_Any_Foreign_Model_Name_Field(
+					'EXM_type',
+					esc_html__(
+						"Model of Attached Thing",
+						"event_espresso"
+					),
+					false,
+					'Transaction',
+					$models_this_can_attach_to
+				),
+				'EXM_key'   => new EE_Plain_Text_Field('EXM_key', esc_html__("Meta Key", "event_espresso"), false, ''),
+				'EXM_value' => new EE_Maybe_Serialized_Text_Field(
+					'EXM_value',
+					esc_html__("Meta Value", "event_espresso"),
+					true
+				),
 
-            ],
-        ];
-        $this->_model_relations    = [];
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
-        }
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] =
-                new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
-        }
-        parent::__construct($timezone);
-    }
+			],
+		];
+		$this->_model_relations    = [];
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Any_Relation();
+		}
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] =
+				new EE_Restriction_Generator_Meta('EXM_key', 'EXM_value');
+		}
+		parent::__construct($timezone);
+	}
 }