eventespresso / event-espresso-core

core/db_models/EEM_Message_Template.model.php

Indentation +68 added lines, -68 removed lines

@@ -10,76 +10,76 @@
  */
 class EEM_Message_Template extends EEM_Base
 {
-    // private instance of the EEM_Message_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Message_Template object
+	protected static $_instance = null;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Message Template', 'event_espresso');
-        $this->plural_item   = esc_html__('Message Templates', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Message Template', 'event_espresso');
+		$this->plural_item   = esc_html__('Message Templates', 'event_espresso');
 
-        $this->_tables = [
-            'Message_Template' => new EE_Primary_Table('esp_message_template', 'MTP_ID'),
-        ];
-        $this->_fields = [
-            'Message_Template' => [
-                'MTP_ID'             => new EE_Primary_Key_Int_Field(
-                    'MTP_ID',
-                    esc_html__('Message Template ID', 'event_espresso')
-                ),
-                'GRP_ID'             => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('Message Template Group ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Message_Template_Group'
-                ),
-                'MTP_template_field' => new EE_Plain_Text_Field(
-                    'MTP_template_field',
-                    esc_html__(
-                        'Field Name for this Template',
-                        'event_espresso'
-                    ),
-                    false,
-                    'default'
-                ),
-                'MTP_context'        => new EE_Plain_Text_Field(
-                    'MTP_context',
-                    esc_html__(
-                        'Message Type Context for this field',
-                        'event_espresso'
-                    ),
-                    false,
-                    'admin'
-                ),
-                'MTP_content'        => new EE_Serialized_Text_Field(
-                    'MTP_content',
-                    esc_html__(
-                        'The field content for the template',
-                        'event_espresso'
-                    ),
-                    false,
-                    ''
-                ),
-            ],
-        ];
+		$this->_tables = [
+			'Message_Template' => new EE_Primary_Table('esp_message_template', 'MTP_ID'),
+		];
+		$this->_fields = [
+			'Message_Template' => [
+				'MTP_ID'             => new EE_Primary_Key_Int_Field(
+					'MTP_ID',
+					esc_html__('Message Template ID', 'event_espresso')
+				),
+				'GRP_ID'             => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('Message Template Group ID', 'event_espresso'),
+					false,
+					0,
+					'Message_Template_Group'
+				),
+				'MTP_template_field' => new EE_Plain_Text_Field(
+					'MTP_template_field',
+					esc_html__(
+						'Field Name for this Template',
+						'event_espresso'
+					),
+					false,
+					'default'
+				),
+				'MTP_context'        => new EE_Plain_Text_Field(
+					'MTP_context',
+					esc_html__(
+						'Message Type Context for this field',
+						'event_espresso'
+					),
+					false,
+					'admin'
+				),
+				'MTP_content'        => new EE_Serialized_Text_Field(
+					'MTP_content',
+					esc_html__(
+						'The field content for the template',
+						'event_espresso'
+					),
+					false,
+					''
+				),
+			],
+		];
 
-        $this->_model_relations        = [
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Message_Template_Group';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] =
-                new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global');
-        }
-        $this->_caps_slug = 'messages';
-        parent::__construct($timezone);
-    }
+		$this->_model_relations        = [
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Message_Template_Group';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] =
+				new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global');
+		}
+		$this->_caps_slug = 'messages';
+		parent::__construct($timezone);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -76,7 +76,7 @@
         ];
         $this->_model_chain_to_wp_user = 'Message_Template_Group';
         foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] =
+            $this->_cap_restriction_generators[$context] =
                 new EE_Restriction_Generator_Global('Message_Template_Group.MTP_is_global');
         }
         $this->_caps_slug = 'messages';

core/db_models/EEM_Event_Question_Group.model.php

Indentation +104 added lines, -104 removed lines

@@ -14,116 +14,116 @@
  */
 class EEM_Event_Question_Group extends EEM_Base
 {
-    /**
-     * Name of the field indicating an event should use the question group for the primary attendee
-     */
-    const PRIMARY = 'EQG_primary';
+	/**
+	 * Name of the field indicating an event should use the question group for the primary attendee
+	 */
+	const PRIMARY = 'EQG_primary';
 
-    /**
-     * Name of hte field indicating an event should use the question group for additional attendees
-     */
-    const ADDITIONAL = 'EQG_additional';
+	/**
+	 * Name of hte field indicating an event should use the question group for additional attendees
+	 */
+	const ADDITIONAL = 'EQG_additional';
 
-    // private instance of the Event_Question_Group object
-    protected static $_instance = null;
+	// private instance of the Event_Question_Group object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
-        $this->_tables          = [
-            'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
-        ];
-        $this->_fields          = [
-            'Event_Question_Group' => [
-                'EQG_ID'         => new EE_Primary_Key_Int_Field(
-                    'EQG_ID',
-                    esc_html__('Event to Question Group Link ID', 'event_espresso')
-                ),
-                'EVT_ID'         => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Event ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'QSG_ID'         => new EE_Foreign_Key_Int_Field(
-                    'QSG_ID',
-                    esc_html__('Question Group Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Question_Group'
-                ),
-                'EQG_additional' => new EE_Boolean_Field(
-                    'EQG_additional',
-                    esc_html__(
-                        'Flag indicating question is only for additional attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'EQG_primary'    => new EE_Boolean_Field(
-                    'EQG_primary',
-                    esc_html__(
-                        'Flag indicating question is only for primary attendees',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'          => new EE_Belongs_To_Relation(),
-            'Question_Group' => new EE_Belongs_To_Relation(),
-        ];
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
+		$this->_tables          = [
+			'Event_Question_Group' => new EE_Primary_Table('esp_event_question_group', 'EQG_ID'),
+		];
+		$this->_fields          = [
+			'Event_Question_Group' => [
+				'EQG_ID'         => new EE_Primary_Key_Int_Field(
+					'EQG_ID',
+					esc_html__('Event to Question Group Link ID', 'event_espresso')
+				),
+				'EVT_ID'         => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('Event ID', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'QSG_ID'         => new EE_Foreign_Key_Int_Field(
+					'QSG_ID',
+					esc_html__('Question Group Id', 'event_espresso'),
+					false,
+					0,
+					'Question_Group'
+				),
+				'EQG_additional' => new EE_Boolean_Field(
+					'EQG_additional',
+					esc_html__(
+						'Flag indicating question is only for additional attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'EQG_primary'    => new EE_Boolean_Field(
+					'EQG_primary',
+					esc_html__(
+						'Flag indicating question is only for primary attendees',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'          => new EE_Belongs_To_Relation(),
+			'Question_Group' => new EE_Belongs_To_Relation(),
+		];
 
-        // this model is generally available for reading
-        $path_to_event = 'Event';
+		// this model is generally available for reading
+		$path_to_event = 'Event';
 
-        $caps[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
-        $caps[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $caps[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
-        $caps[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
-            $path_to_event,
-            EEM_Base::caps_edit
-        );
-        $this->_cap_restriction_generators = $caps;
-        parent::__construct($timezone);
-    }
+		$caps[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Event_Related_Public($path_to_event);
+		$caps[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$caps[ EEM_Base::caps_edit ]       = new EE_Restriction_Generator_Event_Related_Protected($path_to_event);
+		$caps[ EEM_Base::caps_delete ]     = new EE_Restriction_Generator_Event_Related_Protected(
+			$path_to_event,
+			EEM_Base::caps_edit
+		);
+		$this->_cap_restriction_generators = $caps;
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
-     * this is concerning primary attendees or additional attendees.
-     * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
-     * EQG_additional.
-     *
-     * @param string|boolean|int $context
-     * @return string
-     * @since 4.10.0.p
-     */
-    public function fieldNameForContext($context): string
-    {
-        // Basically do a strict switch statement.
-        switch (true) {
-            case $context === 'additional':
-            case $context === false:
-            case $context === 0:
-                $field_name = EEM_Event_Question_Group::ADDITIONAL;
-                break;
-            case $context === 'primary':
-            case $context === true:
-            case $context === 1:
-            default:
-                $field_name = EEM_Event_Question_Group::PRIMARY;
-        }
-        return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
-    }
+	/**
+	 * Decides whether to use the 'EQG_primary' or newer 'EQG_additional' for use in queries, based on whether
+	 * this is concerning primary attendees or additional attendees.
+	 * If 1, true, or "primary" is passed in, returns EQG_primary. If 0, false, or "additional" is passed in, returns
+	 * EQG_additional.
+	 *
+	 * @param string|boolean|int $context
+	 * @return string
+	 * @since 4.10.0.p
+	 */
+	public function fieldNameForContext($context): string
+	{
+		// Basically do a strict switch statement.
+		switch (true) {
+			case $context === 'additional':
+			case $context === false:
+			case $context === 0:
+				$field_name = EEM_Event_Question_Group::ADDITIONAL;
+				break;
+			case $context === 'primary':
+			case $context === true:
+			case $context === 1:
+			default:
+				$field_name = EEM_Event_Question_Group::PRIMARY;
+		}
+		return apply_filters('FHEE__EEM_Event_Question_Group__fieldNameForContext', $field_name, $context);
+	}
 }

core/db_models/EEM_Payment.model.php

Indentation +339 added lines, -339 removed lines

@@ -9,343 +9,343 @@
  */
 class EEM_Payment extends EEM_Base implements EEMI_Payment
 {
-    // private instance of the Payment object
-    protected static $_instance = null;
-
-
-    /**
-     * Status id in esp_status table that represents an approved payment
-     */
-    const status_id_approved = 'PAP';
-
-
-    /**
-     * Status id in esp_status table that represents a pending payment
-     */
-    const status_id_pending = 'PPN';
-
-
-    /**
-     * Status id in esp_status table that represents a cancelled payment (eg, the
-     * user went to PayPal, but on the paypal site decided to cancel the payment)
-     */
-    const status_id_cancelled = 'PCN';
-
-
-    /**
-     * Status id in esp_status table that represents a payment that was declined by
-     * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
-     */
-    const status_id_declined = 'PDC';
-
-
-    /**
-     * Status id in esp_status table that represents a payment that failed for technical reasons.
-     * (Eg, there was some error in communicating with the payment gateway.)
-     */
-    const status_id_failed = 'PFL';
-
-
-    /**
-     * @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__('Payment', 'event_espresso');
-        $this->plural_item   = esc_html__('Payments', 'event_espresso');
-
-        $this->_tables                 = [
-            'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID'),
-        ];
-        $this->_fields                 = [
-            'Payment' => [
-                'PAY_ID'               => new EE_Primary_Key_Int_Field(
-                    'PAY_ID',
-                    esc_html__('Payment ID', 'event_espresso')
-                ),
-                'TXN_ID'               => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'STS_ID'               => new EE_Foreign_Key_String_Field(
-                    'STS_ID',
-                    esc_html__('Status ID', 'event_espresso'),
-                    false,
-                    EEM_Payment::status_id_failed,
-                    'Status'
-                ),
-                'PAY_timestamp'        => new EE_Datetime_Field(
-                    'PAY_timestamp',
-                    esc_html__(
-                        'Timestamp of when payment was attempted',
-                        'event_espresso'
-                    ),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-                'PAY_source'           => new EE_All_Caps_Text_Field(
-                    'PAY_source',
-                    esc_html__(
-                        'User-friendly description of payment',
-                        'event_espresso'
-                    ),
-                    false,
-                    'CART'
-                ),
-                'PAY_amount'           => new EE_Money_Field(
-                    'PAY_amount',
-                    esc_html__('Amount Payment should be for', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_ID'               => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__("Payment Method ID", 'event_espresso'),
-                    false,
-                    null,
-                    'Payment_Method'
-                ),
-                'PAY_gateway_response' => new EE_Plain_Text_Field(
-                    'PAY_gateway_response',
-                    esc_html__(
-                        'Response from Gateway about the payment',
-                        'event_espresso'
-                    ),
-                    false,
-                    ''
-                ),
-                'PAY_txn_id_chq_nmbr'  => new EE_Plain_Text_Field(
-                    'PAY_txn_id_chq_nmbr',
-                    esc_html__(
-                        'Gateway Transaction ID or Cheque Number',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_po_number'        => new EE_Plain_Text_Field(
-                    'PAY_po_number',
-                    esc_html__(
-                        'Purchase or Sales Number',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_extra_accntng'    => new EE_Simple_HTML_Field(
-                    'PAY_extra_accntng',
-                    esc_html__('Extra Account Info', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PAY_details'          => new EE_Serialized_Text_Field(
-                    'PAY_details',
-                    esc_html__(
-                        'Full Gateway response about payment',
-                        'event_espresso'
-                    ),
-                    true,
-                    ''
-                ),
-                'PAY_redirect_url'     => new EE_Plain_Text_Field(
-                    'PAY_redirect_url',
-                    esc_html__("Redirect URL", 'event_espresso'),
-                    true
-                ),
-                'PAY_redirect_args'    => new EE_Serialized_Text_Field(
-                    'PAY_redirect_args',
-                    esc_html__(
-                        "Key-Value POST vars to send along with redirect",
-                        'event_espresso'
-                    ),
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Transaction'          => new EE_Belongs_To_Relation(),
-            'Status'               => new EE_Belongs_To_Relation(),
-            'Payment_Method'       => new EE_Belongs_To_Relation(),
-            'Registration_Payment' => new EE_Has_Many_Relation(),
-            'Registration'         => new EE_HABTM_Relation('Registration_Payment'),
-        ];
-        $this->_model_chain_to_wp_user = 'Payment_Method';
-        $this->_caps_slug              = 'transactions';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
-     * to the payment. This is handy for verifying an IPN hasn't already been processed.
-     *
-     * @param string $PAY_txn_id_chq_nmbr
-     * @return EE_Payment
-     */
-    public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr)
-    {
-        return $this->get_one([['PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr]]);
-    }
-
-
-    /**
-     *       retrieve  all payments from db for a particular transaction, optionally with
-     *      a particular status
-     *
-     * @access     public
-     * @param        $TXN_ID
-     * @param string $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided,
-     *                                  gets payments with any status
-     * @return     EE_Payment[]
-     */
-    public function get_payments_for_transaction($TXN_ID = false, $status_of_payment = null)
-    {
-        // all payments for a TXN ordered chronologically
-        $query_params = [['TXN_ID' => $TXN_ID], 'order_by' => ['PAY_timestamp' => 'ASC']];
-        // if provided with a status, search specifically for that status. Otherwise get them all
-        if ($status_of_payment) {
-            $query_params[0]['STS_ID'] = $status_of_payment;
-        }
-        // retrieve payments
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * Only gets payments which have been approved
-     *
-     * @param int $TXN_ID
-     * @return EE_Payment[]
-     */
-    public function get_approved_payments_for_transaction($TXN_ID = 0)
-    {
-        return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
-    }
-
-
-    /**
-     * retrieve  all payments from db between two dates,
-     *
-     * @param string $start_date        incoming start date. If empty the beginning of today is used.
-     * @param string $end_date          incoming end date. If empty the end of today is used.
-     * @param string $format            If you include $start_date or $end_date then you must include the format string
-     *                                  for the format your date is in.
-     * @param string $timezone          If your range is in a different timezone then the current setting on this
-     *                                  WordPress install, then include it here.
-     * @return EE_Payment[]
-     * @throws EE_Error
-     */
-    public function get_payments_made_between_dates($start_date = '', $end_date = '', $format = '', $timezone = '')
-    {
-        $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
-        // if $start_date or $end date, verify $format is included.
-        if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
-            throw new EE_Error(
-                esc_html__(
-                    'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
-                    'event_espresso'
-                )
-            );
-        }
-        $now = new DateTime('now');
-        // setup timezone objects once
-        $modelDateTimeZone  = new DateTimeZone($this->_timezone);
-        $passedDateTimeZone = new DateTimeZone($timezone);
-        // setup start date
-        $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
-        $start_date = strtotime($start_date);
-        // setup end date
-        $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
-        EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
-        $end_date = strtotime($end_date);
-
-        // make sure our start date is the lowest value and vice versa
-        $start = min($start_date, $end_date);
-        $end   = max($start_date, $end_date);
-
-        // yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
-        $start_date = $this->convert_datetime_for_query(
-            'PAY_timestamp',
-            date('Y-m-d', $start) . ' 00:00:00',
-            'Y-m-d H:i:s',
-            $this->get_timezone()
-        );
-        $end_date   = $this->convert_datetime_for_query(
-            'PAY_timestamp',
-            date('Y-m-d', $end) . ' 23:59:59',
-            'Y-m-d H:i:s',
-            $this->get_timezone()
-        );
-
-        return $this->get_all([['PAY_timestamp' => ['>=', $start_date], 'PAY_timestamp*' => ['<=', $end_date]]]);
-    }
-
-    /**
-     * methods for EEMI_Payment
-     */
-    /**
-     * returns a string for the approved status
-     *
-     * @return  string
-     */
-    public function approved_status()
-    {
-        return self::status_id_approved;
-    }
-
-
-    /**
-     * returns a string for the pending status
-     *
-     * @return  string
-     */
-    public function pending_status()
-    {
-        return self::status_id_pending;
-    }
-
-
-    /**
-     * returns a string for the cancelled status
-     *
-     * @return  string
-     */
-    public function cancelled_status()
-    {
-        return self::status_id_cancelled;
-    }
-
-
-    /**
-     * returns a string for the failed status
-     *
-     * @return  string
-     */
-    public function failed_status()
-    {
-        return self::status_id_failed;
-    }
-
-
-    /**
-     * returns a string for the declined status
-     *
-     * @return  string
-     */
-    public function declined_status()
-    {
-        return self::status_id_declined;
-    }
+	// private instance of the Payment object
+	protected static $_instance = null;
+
+
+	/**
+	 * Status id in esp_status table that represents an approved payment
+	 */
+	const status_id_approved = 'PAP';
+
+
+	/**
+	 * Status id in esp_status table that represents a pending payment
+	 */
+	const status_id_pending = 'PPN';
+
+
+	/**
+	 * Status id in esp_status table that represents a cancelled payment (eg, the
+	 * user went to PayPal, but on the paypal site decided to cancel the payment)
+	 */
+	const status_id_cancelled = 'PCN';
+
+
+	/**
+	 * Status id in esp_status table that represents a payment that was declined by
+	 * the gateway. (eg, the user's card had no funds, or it was a fraudulent card)
+	 */
+	const status_id_declined = 'PDC';
+
+
+	/**
+	 * Status id in esp_status table that represents a payment that failed for technical reasons.
+	 * (Eg, there was some error in communicating with the payment gateway.)
+	 */
+	const status_id_failed = 'PFL';
+
+
+	/**
+	 * @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__('Payment', 'event_espresso');
+		$this->plural_item   = esc_html__('Payments', 'event_espresso');
+
+		$this->_tables                 = [
+			'Payment' => new EE_Primary_Table('esp_payment', 'PAY_ID'),
+		];
+		$this->_fields                 = [
+			'Payment' => [
+				'PAY_ID'               => new EE_Primary_Key_Int_Field(
+					'PAY_ID',
+					esc_html__('Payment ID', 'event_espresso')
+				),
+				'TXN_ID'               => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'STS_ID'               => new EE_Foreign_Key_String_Field(
+					'STS_ID',
+					esc_html__('Status ID', 'event_espresso'),
+					false,
+					EEM_Payment::status_id_failed,
+					'Status'
+				),
+				'PAY_timestamp'        => new EE_Datetime_Field(
+					'PAY_timestamp',
+					esc_html__(
+						'Timestamp of when payment was attempted',
+						'event_espresso'
+					),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+				'PAY_source'           => new EE_All_Caps_Text_Field(
+					'PAY_source',
+					esc_html__(
+						'User-friendly description of payment',
+						'event_espresso'
+					),
+					false,
+					'CART'
+				),
+				'PAY_amount'           => new EE_Money_Field(
+					'PAY_amount',
+					esc_html__('Amount Payment should be for', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_ID'               => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					esc_html__("Payment Method ID", 'event_espresso'),
+					false,
+					null,
+					'Payment_Method'
+				),
+				'PAY_gateway_response' => new EE_Plain_Text_Field(
+					'PAY_gateway_response',
+					esc_html__(
+						'Response from Gateway about the payment',
+						'event_espresso'
+					),
+					false,
+					''
+				),
+				'PAY_txn_id_chq_nmbr'  => new EE_Plain_Text_Field(
+					'PAY_txn_id_chq_nmbr',
+					esc_html__(
+						'Gateway Transaction ID or Cheque Number',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_po_number'        => new EE_Plain_Text_Field(
+					'PAY_po_number',
+					esc_html__(
+						'Purchase or Sales Number',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_extra_accntng'    => new EE_Simple_HTML_Field(
+					'PAY_extra_accntng',
+					esc_html__('Extra Account Info', 'event_espresso'),
+					true,
+					''
+				),
+				'PAY_details'          => new EE_Serialized_Text_Field(
+					'PAY_details',
+					esc_html__(
+						'Full Gateway response about payment',
+						'event_espresso'
+					),
+					true,
+					''
+				),
+				'PAY_redirect_url'     => new EE_Plain_Text_Field(
+					'PAY_redirect_url',
+					esc_html__("Redirect URL", 'event_espresso'),
+					true
+				),
+				'PAY_redirect_args'    => new EE_Serialized_Text_Field(
+					'PAY_redirect_args',
+					esc_html__(
+						"Key-Value POST vars to send along with redirect",
+						'event_espresso'
+					),
+					true
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Transaction'          => new EE_Belongs_To_Relation(),
+			'Status'               => new EE_Belongs_To_Relation(),
+			'Payment_Method'       => new EE_Belongs_To_Relation(),
+			'Registration_Payment' => new EE_Has_Many_Relation(),
+			'Registration'         => new EE_HABTM_Relation('Registration_Payment'),
+		];
+		$this->_model_chain_to_wp_user = 'Payment_Method';
+		$this->_caps_slug              = 'transactions';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets the payment by the gateway server's unique ID. Eg, the unique ID PayPal assigned
+	 * to the payment. This is handy for verifying an IPN hasn't already been processed.
+	 *
+	 * @param string $PAY_txn_id_chq_nmbr
+	 * @return EE_Payment
+	 */
+	public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr)
+	{
+		return $this->get_one([['PAY_txn_id_chq_nmbr' => $PAY_txn_id_chq_nmbr]]);
+	}
+
+
+	/**
+	 *       retrieve  all payments from db for a particular transaction, optionally with
+	 *      a particular status
+	 *
+	 * @access     public
+	 * @param        $TXN_ID
+	 * @param string $status_of_payment one of EEM_Payment::status_id_*, like 'PAP','PCN',etc. If none is provided,
+	 *                                  gets payments with any status
+	 * @return     EE_Payment[]
+	 */
+	public function get_payments_for_transaction($TXN_ID = false, $status_of_payment = null)
+	{
+		// all payments for a TXN ordered chronologically
+		$query_params = [['TXN_ID' => $TXN_ID], 'order_by' => ['PAY_timestamp' => 'ASC']];
+		// if provided with a status, search specifically for that status. Otherwise get them all
+		if ($status_of_payment) {
+			$query_params[0]['STS_ID'] = $status_of_payment;
+		}
+		// retrieve payments
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * Only gets payments which have been approved
+	 *
+	 * @param int $TXN_ID
+	 * @return EE_Payment[]
+	 */
+	public function get_approved_payments_for_transaction($TXN_ID = 0)
+	{
+		return $this->get_payments_for_transaction($TXN_ID, EEM_Payment::status_id_approved);
+	}
+
+
+	/**
+	 * retrieve  all payments from db between two dates,
+	 *
+	 * @param string $start_date        incoming start date. If empty the beginning of today is used.
+	 * @param string $end_date          incoming end date. If empty the end of today is used.
+	 * @param string $format            If you include $start_date or $end_date then you must include the format string
+	 *                                  for the format your date is in.
+	 * @param string $timezone          If your range is in a different timezone then the current setting on this
+	 *                                  WordPress install, then include it here.
+	 * @return EE_Payment[]
+	 * @throws EE_Error
+	 */
+	public function get_payments_made_between_dates($start_date = '', $end_date = '', $format = '', $timezone = '')
+	{
+		$timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
+		// if $start_date or $end date, verify $format is included.
+		if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
+			throw new EE_Error(
+				esc_html__(
+					'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
+					'event_espresso'
+				)
+			);
+		}
+		$now = new DateTime('now');
+		// setup timezone objects once
+		$modelDateTimeZone  = new DateTimeZone($this->_timezone);
+		$passedDateTimeZone = new DateTimeZone($timezone);
+		// setup start date
+		$start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
+		$start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+		$start_date = strtotime($start_date);
+		// setup end date
+		$end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
+		EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
+		$end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+		$end_date = strtotime($end_date);
+
+		// make sure our start date is the lowest value and vice versa
+		$start = min($start_date, $end_date);
+		$end   = max($start_date, $end_date);
+
+		// yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
+		$start_date = $this->convert_datetime_for_query(
+			'PAY_timestamp',
+			date('Y-m-d', $start) . ' 00:00:00',
+			'Y-m-d H:i:s',
+			$this->get_timezone()
+		);
+		$end_date   = $this->convert_datetime_for_query(
+			'PAY_timestamp',
+			date('Y-m-d', $end) . ' 23:59:59',
+			'Y-m-d H:i:s',
+			$this->get_timezone()
+		);
+
+		return $this->get_all([['PAY_timestamp' => ['>=', $start_date], 'PAY_timestamp*' => ['<=', $end_date]]]);
+	}
+
+	/**
+	 * methods for EEMI_Payment
+	 */
+	/**
+	 * returns a string for the approved status
+	 *
+	 * @return  string
+	 */
+	public function approved_status()
+	{
+		return self::status_id_approved;
+	}
+
+
+	/**
+	 * returns a string for the pending status
+	 *
+	 * @return  string
+	 */
+	public function pending_status()
+	{
+		return self::status_id_pending;
+	}
+
+
+	/**
+	 * returns a string for the cancelled status
+	 *
+	 * @return  string
+	 */
+	public function cancelled_status()
+	{
+		return self::status_id_cancelled;
+	}
+
+
+	/**
+	 * returns a string for the failed status
+	 *
+	 * @return  string
+	 */
+	public function failed_status()
+	{
+		return self::status_id_failed;
+	}
+
+
+	/**
+	 * returns a string for the declined status
+	 *
+	 * @return  string
+	 */
+	public function declined_status()
+	{
+		return self::status_id_declined;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -171,7 +171,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Transaction'          => new EE_Belongs_To_Relation(),
             'Status'               => new EE_Belongs_To_Relation(),
             'Payment_Method'       => new EE_Belongs_To_Relation(),
@@ -248,7 +248,7 @@ 
     {
         $timezone = empty($timezone) ? EEH_DTT_Helper::get_timezone() : $timezone;
         // if $start_date or $end date, verify $format is included.
-        if ((! empty($start_date) || ! empty($end_date)) && empty($format)) {
+        if (( ! empty($start_date) || ! empty($end_date)) && empty($format)) {
             throw new EE_Error(
                 esc_html__(
                     'You included a start date and/or a end date for this method but did not include a format string.  The format string is needed for setting up the query',
@@ -263,12 +263,12 @@ 
         // setup start date
         $start_date = ! empty($start_date) ? date_create_from_format($format, $start_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($start_date, $modelDateTimeZone);
-        $start_date = $start_date->format('Y-m-d') . ' 00:00:00';
+        $start_date = $start_date->format('Y-m-d').' 00:00:00';
         $start_date = strtotime($start_date);
         // setup end date
         $end_date = ! empty($end_date) ? date_create_from_format($format, $end_date, $passedDateTimeZone) : $now;
         EEH_DTT_Helper::setTimezone($end_date, $modelDateTimeZone);
-        $end_date = $end_date->format('Y-m-d') . ' 23:59:59';
+        $end_date = $end_date->format('Y-m-d').' 23:59:59';
         $end_date = strtotime($end_date);
 
         // make sure our start date is the lowest value and vice versa
@@ -278,13 +278,13 @@ 
         // yes we generated the date and time string in utc but we WANT this start date and time used in the set timezone on the model.
         $start_date = $this->convert_datetime_for_query(
             'PAY_timestamp',
-            date('Y-m-d', $start) . ' 00:00:00',
+            date('Y-m-d', $start).' 00:00:00',
             'Y-m-d H:i:s',
             $this->get_timezone()
         );
-        $end_date   = $this->convert_datetime_for_query(
+        $end_date = $this->convert_datetime_for_query(
             'PAY_timestamp',
-            date('Y-m-d', $end) . ' 23:59:59',
+            date('Y-m-d', $end).' 23:59:59',
             'Y-m-d H:i:s',
             $this->get_timezone()
         );

core/db_models/EEM_Question_Option.model.php

Indentation +74 added lines, -74 removed lines

@@ -9,84 +9,84 @@
  */
 class EEM_Question_Option extends EEM_Soft_Delete_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Question Option', 'event_espresso');
-        $this->plural_item   = esc_html__('Question Options', 'event_espresso');
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Question Option', 'event_espresso');
+		$this->plural_item   = esc_html__('Question Options', 'event_espresso');
 
-        $this->_tables          = [
-            'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
-        ];
-        $this->_fields          = [
-            'Question_Option' => [
-                'QSO_ID'      => new EE_Primary_Key_Int_Field(
-                    'QSO_ID',
-                    esc_html__('Question Option ID', 'event_espresso')
-                ),
-                'QST_ID'      => new EE_Foreign_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Question'
-                ),
-                'QSO_deleted' => new EE_Trashed_Flag_Field(
-                    'QSO_deleted',
-                    esc_html__('Flag indicating Option was trashed', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QSO_desc'    => new EE_Post_Content_Field(
-                    'QSO_desc',
-                    esc_html__('Question Option Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QSO_order'   => new EE_Integer_Field(
-                    'QSO_order',
-                    esc_html__('Question Option Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QSO_system'  => new EE_Plain_Text_Field(
-                    'QSO_system',
-                    esc_html__('Internal string ID for question option', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'QSO_value'   => new EE_Plain_Text_Field(
-                    'QSO_value',
-                    esc_html__("Question Option Value", "event_espresso"),
-                    false,
-                    ''
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Question' => new EE_Belongs_To_Relation(),
-        ];
+		$this->_tables          = [
+			'Question_Option' => new EE_Primary_Table('esp_question_option', 'QSO_ID'),
+		];
+		$this->_fields          = [
+			'Question_Option' => [
+				'QSO_ID'      => new EE_Primary_Key_Int_Field(
+					'QSO_ID',
+					esc_html__('Question Option ID', 'event_espresso')
+				),
+				'QST_ID'      => new EE_Foreign_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso'),
+					false,
+					0,
+					'Question'
+				),
+				'QSO_deleted' => new EE_Trashed_Flag_Field(
+					'QSO_deleted',
+					esc_html__('Flag indicating Option was trashed', 'event_espresso'),
+					false,
+					false
+				),
+				'QSO_desc'    => new EE_Post_Content_Field(
+					'QSO_desc',
+					esc_html__('Question Option Description', 'event_espresso'),
+					false,
+					''
+				),
+				'QSO_order'   => new EE_Integer_Field(
+					'QSO_order',
+					esc_html__('Question Option Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QSO_system'  => new EE_Plain_Text_Field(
+					'QSO_system',
+					esc_html__('Internal string ID for question option', 'event_espresso'),
+					true,
+					null
+				),
+				'QSO_value'   => new EE_Plain_Text_Field(
+					'QSO_value',
+					esc_html__("Question Option Value", "event_espresso"),
+					false,
+					''
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Question' => new EE_Belongs_To_Relation(),
+		];
 
-        $this->_caps_slug              = 'questions';
-        $this->_model_chain_to_wp_user = 'Question';
+		$this->_caps_slug              = 'questions';
+		$this->_model_chain_to_wp_user = 'Question';
 
-        // 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('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Reg_Form('QSO_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Reg_Form('QSO_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('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Reg_Form('QSO_system');
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Price_Type.model.php

Indentation +198 added lines, -198 removed lines

@@ -10,202 +10,202 @@
  */
 class EEM_Price_Type extends EEM_Soft_Delete_Base
 {
-    // private instance of the Price Type object
-    protected static $_instance = null;
-
-    // An array of the price type objects
-    public $type = null;
-
-    /**
-     *   Price Base types
-     *
-     * @access private
-     * @var int
-     */
-    public $base_types = null;
-
-
-    /**
-     * return an array of Base types. Keys are INTs which are used in the database,
-     * values are text-representations of the base type.
-     *
-     * @return array
-     */
-    public function get_base_types()
-    {
-        return $this->base_types;
-    }
-
-
-    /**
-     * Gets the name of the base
-     *
-     * @param type $base_type_int
-     * @return type
-     */
-    public function get_base_type_name($base_type_int)
-    {
-        return $this->base_types[ $base_type_int ];
-    }
-
-
-    /**
-     * constants for price base types. In the DB, we decided to store the price base type
-     * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
-     * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
-     * So, as an example, to query for all price types that are a tax, we'd do
-     * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
-     * instead of
-     * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
-     * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
-     * change, we can continue to use the constant, by simply change its value.
-     */
-    const base_type_base_price = 1;
-
-    const base_type_discount   = 2;
-
-    const base_type_surcharge  = 3;
-
-    const base_type_tax        = 4;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone
-     * @return void
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->base_types    = [
-            EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
-            EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
-            EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
-            EEM_Price_Type::base_type_tax        => esc_html__('Tax', 'event_espresso'),
-        ];
-        $this->singular_item = esc_html__('Price Type', 'event_espresso');
-        $this->plural_item   = esc_html__('Price Types', 'event_espresso');
-
-        $this->_tables          = [
-            'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID'),
-        ];
-        $this->_fields          = [
-            'Price_Type' => [
-                'PRT_ID'         => new EE_Primary_Key_Int_Field(
-                    'PRT_ID', esc_html__('Price Type ID', 'event_espresso')
-                ),
-                'PRT_name'       => new EE_Plain_Text_Field(
-                    'PRT_name',
-                    esc_html__('Price Type Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PBT_ID'         => new EE_Enum_Integer_Field(
-                    'PBT_ID',
-                    esc_html__(
-                        'Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax',
-                        'event_espresso'
-                    ),
-                    false,
-                    EEM_Price_Type::base_type_base_price,
-                    $this->base_types
-                ),
-                'PRT_is_percent' => new EE_Boolean_Field(
-                    'PRT_is_percent',
-                    esc_html__(
-                        'Flag indicating price is a percentage',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'PRT_order'      => new EE_Integer_Field(
-                    'PRT_order',
-                    esc_html__(
-                        'Order in which price should be applied. ',
-                        'event_espresso'
-                    ),
-                    false,
-                    0
-                ),
-                'PRT_deleted'    => new EE_Trashed_Flag_Field(
-                    'PRT_deleted',
-                    esc_html__(
-                        'Flag indicating price type has been trashed',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'PRT_wp_user'    => new EE_WP_User_Field(
-                    'PRT_wp_user',
-                    esc_html__('Price Type Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Price'   => new EE_Has_Many_Relation(),
-            'WP_User' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // all price types are "default" in terms of capability names
-        $this->_caps_slug = 'default_price_types';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     *      instantiate a new price type object with blank/empty properties
-     *
-     * @access     public
-     * @return     mixed       array on success, FALSE on fail
-     */
-    public function get_new_price_type()
-    {
-        return EE_Price_Type::new_instance();
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param bool  $allow_blocking   if TRUE, matched objects will only be deleted if there is no related model info
-     *                                that blocks it (ie, there' sno other data that depends on this data);
-     *                                if false, deletes regardless of other objects which may depend on it.
-     *                                Its generally advisable to always leave this as TRUE,
-     *                                otherwise you could easily corrupt your DB
-     * @return bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function delete_permanently($query_params = [], $allow_blocking = true)
-    {
-        $would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
-        $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
-
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
-
-        // check if any prices use this price type
-        $prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
-        if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
-            $prices_names_and_ids = [];
-            foreach ($prices as $price) {
-                /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
-            }
-            $msg = sprintf(
-                esc_html__(
-                    'The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s',
-                    'event_espresso'
-                ),
-                implode(",", $prices_names_and_ids)
-            );
-            EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
-            return false;
-        }
-
-        return parent::delete_permanently($query_params);
-    }
+	// private instance of the Price Type object
+	protected static $_instance = null;
+
+	// An array of the price type objects
+	public $type = null;
+
+	/**
+	 *   Price Base types
+	 *
+	 * @access private
+	 * @var int
+	 */
+	public $base_types = null;
+
+
+	/**
+	 * return an array of Base types. Keys are INTs which are used in the database,
+	 * values are text-representations of the base type.
+	 *
+	 * @return array
+	 */
+	public function get_base_types()
+	{
+		return $this->base_types;
+	}
+
+
+	/**
+	 * Gets the name of the base
+	 *
+	 * @param type $base_type_int
+	 * @return type
+	 */
+	public function get_base_type_name($base_type_int)
+	{
+		return $this->base_types[ $base_type_int ];
+	}
+
+
+	/**
+	 * constants for price base types. In the DB, we decided to store the price base type
+	 * as an integer. So, to avoid just having magic numbers everwhere (eg, querying for
+	 * all price types with PBT_ID = 2), we define these constants, to make code more understandable.
+	 * So, as an example, to query for all price types that are a tax, we'd do
+	 * EEM_PRice_Type::instance()->get_all(array(array('PBT_ID'=>EEM_Price_Type::base_type_tax)))
+	 * instead of
+	 * EEM_Price_Type::instance()->get_all(array(array('PBT_ID'=>2)))
+	 * Although the 2nd is shorter, it's much less obvious what it's doing. Also, should these magic IDs ever
+	 * change, we can continue to use the constant, by simply change its value.
+	 */
+	const base_type_base_price = 1;
+
+	const base_type_discount   = 2;
+
+	const base_type_surcharge  = 3;
+
+	const base_type_tax        = 4;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone
+	 * @return void
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->base_types    = [
+			EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
+			EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
+			EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
+			EEM_Price_Type::base_type_tax        => esc_html__('Tax', 'event_espresso'),
+		];
+		$this->singular_item = esc_html__('Price Type', 'event_espresso');
+		$this->plural_item   = esc_html__('Price Types', 'event_espresso');
+
+		$this->_tables          = [
+			'Price_Type' => new EE_Primary_Table('esp_price_type', 'PRT_ID'),
+		];
+		$this->_fields          = [
+			'Price_Type' => [
+				'PRT_ID'         => new EE_Primary_Key_Int_Field(
+					'PRT_ID', esc_html__('Price Type ID', 'event_espresso')
+				),
+				'PRT_name'       => new EE_Plain_Text_Field(
+					'PRT_name',
+					esc_html__('Price Type Name', 'event_espresso'),
+					false,
+					''
+				),
+				'PBT_ID'         => new EE_Enum_Integer_Field(
+					'PBT_ID',
+					esc_html__(
+						'Price Base type ID, 1 = Price , 2 = Discount , 3 = Surcharge , 4 = Tax',
+						'event_espresso'
+					),
+					false,
+					EEM_Price_Type::base_type_base_price,
+					$this->base_types
+				),
+				'PRT_is_percent' => new EE_Boolean_Field(
+					'PRT_is_percent',
+					esc_html__(
+						'Flag indicating price is a percentage',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'PRT_order'      => new EE_Integer_Field(
+					'PRT_order',
+					esc_html__(
+						'Order in which price should be applied. ',
+						'event_espresso'
+					),
+					false,
+					0
+				),
+				'PRT_deleted'    => new EE_Trashed_Flag_Field(
+					'PRT_deleted',
+					esc_html__(
+						'Flag indicating price type has been trashed',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'PRT_wp_user'    => new EE_WP_User_Field(
+					'PRT_wp_user',
+					esc_html__('Price Type Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Price'   => new EE_Has_Many_Relation(),
+			'WP_User' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// all price types are "default" in terms of capability names
+		$this->_caps_slug = 'default_price_types';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 *      instantiate a new price type object with blank/empty properties
+	 *
+	 * @access     public
+	 * @return     mixed       array on success, FALSE on fail
+	 */
+	public function get_new_price_type()
+	{
+		return EE_Price_Type::new_instance();
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param bool  $allow_blocking   if TRUE, matched objects will only be deleted if there is no related model info
+	 *                                that blocks it (ie, there' sno other data that depends on this data);
+	 *                                if false, deletes regardless of other objects which may depend on it.
+	 *                                Its generally advisable to always leave this as TRUE,
+	 *                                otherwise you could easily corrupt your DB
+	 * @return bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function delete_permanently($query_params = [], $allow_blocking = true)
+	{
+		$would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
+		$would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
+
+		$ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+
+		// check if any prices use this price type
+		$prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
+		if ($prices = $this->get_all_related($ID, 'Price', $prc_query_params)) {
+			$prices_names_and_ids = [];
+			foreach ($prices as $price) {
+				/* @var $price EE_Price */
+				$prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+			}
+			$msg = sprintf(
+				esc_html__(
+					'The Price Type(s) could not be deleted because there are existing Prices that currently use this Price Type.  If you still wish to delete this Price Type, then either delete those Prices or change them to use other Price Types.The prices are: %s',
+					'event_espresso'
+				),
+				implode(",", $prices_names_and_ids)
+			);
+			EE_Error::add_error($msg, __FILE__, __FUNCTION__, __LINE__);
+			return false;
+		}
+
+		return parent::delete_permanently($query_params);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -45,7 +45,7 @@ 
      */
     public function get_base_type_name($base_type_int)
     {
-        return $this->base_types[ $base_type_int ];
+        return $this->base_types[$base_type_int];
     }
 
 
@@ -78,7 +78,7 @@ 
      */
     protected function __construct(?string $timezone = '')
     {
-        $this->base_types    = [
+        $this->base_types = [
             EEM_Price_Type::base_type_base_price => esc_html__('Price', 'event_espresso'),
             EEM_Price_Type::base_type_discount   => esc_html__('Discount', 'event_espresso'),
             EEM_Price_Type::base_type_surcharge  => esc_html__('Surcharge', 'event_espresso'),
@@ -150,7 +150,7 @@ 
             'WP_User' => new EE_Belongs_To_Relation(),
         ];
         // 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] = new EE_Restriction_Generator_Public();
         // all price types are "default" in terms of capability names
         $this->_caps_slug = 'default_price_types';
         parent::__construct($timezone);
@@ -185,7 +185,7 @@ 
         $would_be_deleted_price_types    = $this->get_all_deleted_and_undeleted($query_params);
         $would_be_deleted_price_type_ids = array_keys($would_be_deleted_price_types);
 
-        $ID = $query_params[0][ $this->get_primary_key_field()->get_name() ];
+        $ID = $query_params[0][$this->get_primary_key_field()->get_name()];
 
         // check if any prices use this price type
         $prc_query_params = [['PRT_ID' => ['IN', $would_be_deleted_price_type_ids]]];
@@ -193,7 +193,7 @@ 
             $prices_names_and_ids = [];
             foreach ($prices as $price) {
                 /* @var $price EE_Price */
-                $prices_names_and_ids[] = $price->name() . "(" . $price->ID() . ")";
+                $prices_names_and_ids[] = $price->name()."(".$price->ID().")";
             }
             $msg = sprintf(
                 esc_html__(

core/db_models/EEM_Currency_Payment_Method.model.php

Indentation +43 added lines, -43 removed lines

@@ -9,49 +9,49 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    protected static ?EEM_Currency_Payment_Method $_instance = null;
+	protected static ?EEM_Currency_Payment_Method $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Currency Usable by Payment Method', 'event_espresso');
-        $this->plural_item      = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
-        $this->_tables          = [
-            'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID'),
-        ];
-        $this->_fields          = [
-            'Currency_Payment_Method' => [
-                'CPM_ID'   => new EE_Primary_Key_Int_Field(
-                    'CPM_ID',
-                    esc_html__('Currency to Payment Method LInk ID', 'event_espresso')
-                ),
-                'CUR_code' => new EE_Foreign_Key_String_Field(
-                    'CUR_code',
-                    esc_html__('Currency Code', 'event_espresso'),
-                    false,
-                    '',
-                    'Currency'
-                ),
-                'PMD_ID'   => new EE_Foreign_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('Paymetn Method ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Payment_Method'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Currency'       => new EE_Belongs_To_Relation(),
-            'Payment_Method' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->_caps_slug                                         = 'payment_methods';
-        parent::__construct($timezone);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Currency Usable by Payment Method', 'event_espresso');
+		$this->plural_item      = esc_html__('Currencies Usable by Payment Methods', 'event_espresso');
+		$this->_tables          = [
+			'Currency_Payment_Method' => new EE_Primary_Table('esp_currency_payment_method', 'CPM_ID'),
+		];
+		$this->_fields          = [
+			'Currency_Payment_Method' => [
+				'CPM_ID'   => new EE_Primary_Key_Int_Field(
+					'CPM_ID',
+					esc_html__('Currency to Payment Method LInk ID', 'event_espresso')
+				),
+				'CUR_code' => new EE_Foreign_Key_String_Field(
+					'CUR_code',
+					esc_html__('Currency Code', 'event_espresso'),
+					false,
+					'',
+					'Currency'
+				),
+				'PMD_ID'   => new EE_Foreign_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('Paymetn Method ID', 'event_espresso'),
+					false,
+					0,
+					'Payment_Method'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Currency'       => new EE_Belongs_To_Relation(),
+			'Payment_Method' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->_caps_slug                                         = 'payment_methods';
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Country.model.php

Indentation +209 added lines, -209 removed lines

@@ -10,213 +10,213 @@
  */
 class EEM_Country extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
-
-    // array of all countries
-    private static $_all_countries = false;
-
-    // array of all active countries
-    private static $_active_countries = false;
-
-
-    /**
-     * Resets the country
-     *
-     * @param string|null $timezone
-     * @return EEM_Country|EEM_Base|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function reset($timezone = '')
-    {
-        self::$_active_countries = null;
-        self::$_all_countries    = null;
-        return parent::reset($timezone);
-    }
-
-
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Country', 'event_espresso');
-        $this->plural_item   = esc_html__('Countries', 'event_espresso');
-
-        $this->_tables = [
-            'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
-        ];
-
-        $this->_fields          = [
-            'Country' => [
-                'CNT_active'      => new EE_Boolean_Field(
-                    'CNT_active',
-                    esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_ISO'         => new EE_Primary_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__('Country ISO Code', 'event_espresso')
-                ),
-                'CNT_ISO3'        => new EE_All_Caps_Text_Field(
-                    'CNT_ISO3',
-                    esc_html__('Country ISO3 Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'RGN_ID'          => new EE_Integer_Field(
-                    'RGN_ID',
-                    esc_html__('Region ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                // should be a foreign key, but no region table exists yet
-                'CNT_name'        => new EE_Plain_Text_Field(
-                    'CNT_name',
-                    esc_html__('Country Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_cur_code'    => new EE_All_Caps_Text_Field(
-                    'CNT_cur_code',
-                    esc_html__('Country Currency Code', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_single'  => new EE_Plain_Text_Field(
-                    'CNT_cur_single',
-                    esc_html__('Currency Name Singular', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_plural'  => new EE_Plain_Text_Field(
-                    'CNT_cur_plural',
-                    esc_html__('Currency Name Plural', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign'    => new EE_Plain_Text_Field(
-                    'CNT_cur_sign',
-                    esc_html__('Currency Sign', 'event_espresso'),
-                    false
-                ),
-                'CNT_cur_sign_b4' => new EE_Boolean_Field(
-                    'CNT_cur_sign_b4',
-                    esc_html__('Currency Sign Before Number', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CNT_cur_dec_plc' => new EE_Integer_Field(
-                    'CNT_cur_dec_plc',
-                    esc_html__('Currency Decimal Places', 'event_espresso'),
-                    false,
-                    2
-                ),
-                'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
-                    'CNT_cur_dec_mrk',
-                    esc_html__('Currency Decimal Mark', 'event_espresso'),
-                    false,
-                    '.'
-                ),
-                'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
-                    'CNT_cur_thsnds',
-                    esc_html__('Currency Thousands Separator', 'event_espresso'),
-                    false,
-                    ','
-                ),
-                'CNT_tel_code'    => new EE_Plain_Text_Field(
-                    'CNT_tel_code',
-                    esc_html__('Country Telephone Code', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'CNT_is_EU'       => new EE_Boolean_Field(
-                    'CNT_is_EU',
-                    esc_html__('Country is Member of EU', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee' => new EE_Has_Many_Relation(),
-            'State'    => new EE_Has_Many_Relation(),
-            'Venue'    => new EE_Has_Many_Relation(),
-        ];
-        // only anyone to view, but only those with the default role can do anything
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_countries()
-    {
-        if (! self::$_all_countries) {
-            self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_all_countries;
-    }
-
-
-    /**
-     * Gets and caches the list of active countries. If you know the list of active countries
-     * has changed during this request, first use EEM_Country::reset() to flush the cache
-     *
-     * @return EE_Country[]
-     * @throws EE_Error
-     */
-    public function get_all_active_countries()
-    {
-        if (! self::$_active_countries) {
-            self::$_active_countries =
-                $this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_active_countries;
-    }
-
-
-    /**
-     * Gets the country's name by its ISO
-     *
-     * @param string $country_ISO
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_country_name_by_ISO($country_ISO)
-    {
-        $countries = $this->get_all_countries();
-        if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
-            return $countries[ $country_ISO ]->name();
-        }
-        $names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
-        if (is_array($names) && ! empty($names)) {
-            return reset($names);
-        } else {
-            return '';
-        }
-    }
-
-
-    /**
-     * Gets the country's name by its name
-     *
-     * @param string $country_name
-     * @return EE_Country|null
-     * @throws EE_Error
-     */
-    public function getCountryByName($country_name)
-    {
-        $countries = $this->get_all_countries();
-        foreach ($countries as $country) {
-            if ($country instanceof EE_Country && $country->name() === $country_name) {
-                return $country;
-            }
-        }
-        return $this->get_one([['CNT_name' => $country_name]]);
-    }
+	// private instance of the Attendee object
+	protected static $_instance = null;
+
+	// array of all countries
+	private static $_all_countries = false;
+
+	// array of all active countries
+	private static $_active_countries = false;
+
+
+	/**
+	 * Resets the country
+	 *
+	 * @param string|null $timezone
+	 * @return EEM_Country|EEM_Base|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function reset($timezone = '')
+	{
+		self::$_active_countries = null;
+		self::$_all_countries    = null;
+		return parent::reset($timezone);
+	}
+
+
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Country', 'event_espresso');
+		$this->plural_item   = esc_html__('Countries', 'event_espresso');
+
+		$this->_tables = [
+			'Country' => new EE_Primary_Table('esp_country', 'CNT_ISO'),
+		];
+
+		$this->_fields          = [
+			'Country' => [
+				'CNT_active'      => new EE_Boolean_Field(
+					'CNT_active',
+					esc_html__('Country Appears in Dropdown Select Lists', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_ISO'         => new EE_Primary_Key_String_Field(
+					'CNT_ISO',
+					esc_html__('Country ISO Code', 'event_espresso')
+				),
+				'CNT_ISO3'        => new EE_All_Caps_Text_Field(
+					'CNT_ISO3',
+					esc_html__('Country ISO3 Code', 'event_espresso'),
+					false,
+					''
+				),
+				'RGN_ID'          => new EE_Integer_Field(
+					'RGN_ID',
+					esc_html__('Region ID', 'event_espresso'),
+					false,
+					0
+				),
+				// should be a foreign key, but no region table exists yet
+				'CNT_name'        => new EE_Plain_Text_Field(
+					'CNT_name',
+					esc_html__('Country Name', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_cur_code'    => new EE_All_Caps_Text_Field(
+					'CNT_cur_code',
+					esc_html__('Country Currency Code', 'event_espresso'),
+					false
+				),
+				'CNT_cur_single'  => new EE_Plain_Text_Field(
+					'CNT_cur_single',
+					esc_html__('Currency Name Singular', 'event_espresso'),
+					false
+				),
+				'CNT_cur_plural'  => new EE_Plain_Text_Field(
+					'CNT_cur_plural',
+					esc_html__('Currency Name Plural', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign'    => new EE_Plain_Text_Field(
+					'CNT_cur_sign',
+					esc_html__('Currency Sign', 'event_espresso'),
+					false
+				),
+				'CNT_cur_sign_b4' => new EE_Boolean_Field(
+					'CNT_cur_sign_b4',
+					esc_html__('Currency Sign Before Number', 'event_espresso'),
+					false,
+					true
+				),
+				'CNT_cur_dec_plc' => new EE_Integer_Field(
+					'CNT_cur_dec_plc',
+					esc_html__('Currency Decimal Places', 'event_espresso'),
+					false,
+					2
+				),
+				'CNT_cur_dec_mrk' => new EE_Plain_Text_Field(
+					'CNT_cur_dec_mrk',
+					esc_html__('Currency Decimal Mark', 'event_espresso'),
+					false,
+					'.'
+				),
+				'CNT_cur_thsnds'  => new EE_Plain_Text_Field(
+					'CNT_cur_thsnds',
+					esc_html__('Currency Thousands Separator', 'event_espresso'),
+					false,
+					','
+				),
+				'CNT_tel_code'    => new EE_Plain_Text_Field(
+					'CNT_tel_code',
+					esc_html__('Country Telephone Code', 'event_espresso'),
+					false,
+					''
+				),
+				'CNT_is_EU'       => new EE_Boolean_Field(
+					'CNT_is_EU',
+					esc_html__('Country is Member of EU', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee' => new EE_Has_Many_Relation(),
+			'State'    => new EE_Has_Many_Relation(),
+			'Venue'    => new EE_Has_Many_Relation(),
+		];
+		// only anyone to view, but only those with the default role can do anything
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_countries()
+	{
+		if (! self::$_all_countries) {
+			self::$_all_countries = $this->get_all(['order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_all_countries;
+	}
+
+
+	/**
+	 * Gets and caches the list of active countries. If you know the list of active countries
+	 * has changed during this request, first use EEM_Country::reset() to flush the cache
+	 *
+	 * @return EE_Country[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active_countries()
+	{
+		if (! self::$_active_countries) {
+			self::$_active_countries =
+				$this->get_all([['CNT_active' => true], 'order_by' => ['CNT_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_active_countries;
+	}
+
+
+	/**
+	 * Gets the country's name by its ISO
+	 *
+	 * @param string $country_ISO
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_country_name_by_ISO($country_ISO)
+	{
+		$countries = $this->get_all_countries();
+		if (isset($countries[ $country_ISO ]) && $countries[ $country_ISO ] instanceof EE_Country) {
+			return $countries[ $country_ISO ]->name();
+		}
+		$names = $this->get_col([['CNT_ISO' => $country_ISO], 'limit' => 1], 'CNT_name');
+		if (is_array($names) && ! empty($names)) {
+			return reset($names);
+		} else {
+			return '';
+		}
+	}
+
+
+	/**
+	 * Gets the country's name by its name
+	 *
+	 * @param string $country_name
+	 * @return EE_Country|null
+	 * @throws EE_Error
+	 */
+	public function getCountryByName($country_name)
+	{
+		$countries = $this->get_all_countries();
+		foreach ($countries as $country) {
+			if ($country instanceof EE_Country && $country->name() === $country_name) {
+				return $country;
+			}
+		}
+		return $this->get_one([['CNT_name' => $country_name]]);
+	}
 }

core/db_models/EEM_Event.model.php

Indentation +964 added lines, -964 removed lines

@@ -13,968 +13,968 @@
  */
 class EEM_Event extends EEM_CPT_Base
 {
-    /**
-     * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
-     * event
-     */
-    const sold_out = 'sold_out';
-
-    /**
-     * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
-     * date)
-     */
-    const postponed = 'postponed';
-
-    /**
-     * constant used by status(), indicating that the event will no longer occur
-     */
-    const cancelled = 'cancelled';
-
-
-    /**
-     * @var string
-     */
-    protected static $_default_reg_status;
-
-
-    /**
-     * This is the default for the additional limit field.
-     *
-     * @var int
-     */
-    protected static $_default_additional_limit = 10;
-
-
-    /**
-     * private instance of the Event object
-     *
-     * @var EEM_Event
-     */
-    protected static $_instance;
-
-
-    /**
-     * Adds a relationship to Term_Taxonomy for each CPT_Base
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        EE_Registry::instance()->load_model('Registration');
-        $this->singular_item = esc_html__('Event', 'event_espresso');
-        $this->plural_item   = esc_html__('Events', 'event_espresso');
-        // to remove Cancelled events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
-        // to remove Postponed events from the frontend, copy the following filter to your functions.php file
-        // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
-        // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
-        //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati       = apply_filters(
-            'AFEE__EEM_Event__construct___custom_stati',
-            [
-                EEM_Event::cancelled => [
-                    'label'  => esc_html__('Cancelled', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
-                ],
-                EEM_Event::postponed => [
-                    'label'  => esc_html__('Postponed', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
-                ],
-                EEM_Event::sold_out  => [
-                    'label'  => esc_html__('Sold Out', 'event_espresso'),
-                    'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
-                ],
-            ]
-        );
-        self::$_default_reg_status = empty(self::$_default_reg_status)
-            ? EEM_Registration::status_id_pending_payment
-            : self::$_default_reg_status;
-        $this->_tables             = [
-            'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
-        ];
-        $this->_fields             = [
-            'Event_CPT'  => [
-                'EVT_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__('Post ID for Event', 'event_espresso')
-                ),
-                'EVT_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__('Event Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__('Event Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_slug'       => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__('Event Slug', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__('Date/Time Event Created', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_short_desc' => new EE_Simple_HTML_Field(
-                    'post_excerpt',
-                    esc_html__('Event Short Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__('Date/Time Event Modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__('Event Creator ID', 'event_espresso'),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__('Event Parent ID', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'EVT_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__('Event Menu Order', 'event_espresso'),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
-                // EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
-                'status'         => new EE_WP_Post_Status_Field(
-                    'post_status',
-                    esc_html__('Event Status', 'event_espresso'),
-                    false,
-                    'draft',
-                    $this->_custom_stati
-                ),
-                'password'       => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    [
-                        'EVT_desc',
-                        'EVT_short_desc',
-                        'EVT_display_desc',
-                        'EVT_display_ticket_selector',
-                        'EVT_visible_on',
-                        'EVT_additional_limit',
-                        'EVT_default_registration_status',
-                        'EVT_member_only',
-                        'EVT_phone',
-                        'EVT_allow_overflow',
-                        'EVT_timezone_string',
-                        'EVT_external_URL',
-                        'EVT_donations',
-                    ]
-                ),
-            ],
-            'Event_Meta' => [
-                'EVTM_ID'                         => new EE_DB_Only_Float_Field(
-                    'EVTM_ID',
-                    esc_html__('Event Meta Row ID', 'event_espresso'),
-                    false
-                ),
-                'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
-                    'EVT_ID',
-                    esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
-                    false
-                ),
-                'VNU_ID'                          => new EE_Foreign_Key_Int_Field(
-                    'VNU_ID',
-                    __('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                'EVT_display_desc'                => new EE_Boolean_Field(
-                    'EVT_display_desc',
-                    esc_html__('Display Description Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_display_ticket_selector'     => new EE_Boolean_Field(
-                    'EVT_display_ticket_selector',
-                    esc_html__('Display Ticket Selector Flag', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'EVT_visible_on'                  => new EE_Datetime_Field(
-                    'EVT_visible_on',
-                    esc_html__('Event Visible Date', 'event_espresso'),
-                    true,
-                    EE_Datetime_Field::now
-                ),
-                'EVT_additional_limit'            => new EE_Integer_Field(
-                    'EVT_additional_limit',
-                    esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                    false,
-                    self::$_default_additional_limit
-                ),
-                'EVT_default_registration_status' => new EE_Enum_Text_Field(
-                    'EVT_default_registration_status',
-                    esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                    false,
-                    EEM_Event::$_default_reg_status,
-                    EEM_Registration::reg_status_array()
-                ),
-                'EVT_member_only'                 => new EE_Boolean_Field(
-                    'EVT_member_only',
-                    esc_html__('Member-Only Event Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_phone'                       => new EE_Plain_Text_Field(
-                    'EVT_phone',
-                    esc_html__('Event Phone Number', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_allow_overflow'              => new EE_Boolean_Field(
-                    'EVT_allow_overflow',
-                    esc_html__('Allow Overflow on Event', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'EVT_timezone_string'             => new EE_Plain_Text_Field(
-                    'EVT_timezone_string',
-                    esc_html__('Timezone (name) for Event times', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'EVT_external_URL'                => new EE_Plain_Text_Field(
-                    'EVT_external_URL',
-                    esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
-                    true
-                ),
-                'EVT_donations'                   => new EE_Boolean_Field(
-                    'EVT_donations',
-                    esc_html__('Accept Donations?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
-                    true,
-                    null,
-                    'Form_Section',
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations    = [
-            'Attendee'               => new EE_HABTM_Relation('Registration'),
-            'Datetime'               => new EE_Has_Many_Relation(),
-            'Event_Question_Group'   => new EE_Has_Many_Relation(),
-            'Form_Section'           => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
-            'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
-            'Registration'           => new EE_Has_Many_Relation(),
-            'Term_Relationship'      => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
-            'Venue'                  => new EE_Belongs_To_Relation(),
-            'WP_User'                => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        $this->model_chain_to_password                            = '';
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * @param string $default_reg_status
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public static function set_default_reg_status($default_reg_status)
-    {
-        self::$_default_reg_status = $default_reg_status;
-        // if EEM_Event has already been instantiated,
-        // then we need to reset the `EVT_default_reg_status` field to use the new default.
-        if (self::$_instance instanceof EEM_Event) {
-            $default_reg_status = new EE_Enum_Text_Field(
-                'EVT_default_registration_status',
-                esc_html__('Default Registration Status on this Event', 'event_espresso'),
-                false,
-                $default_reg_status,
-                EEM_Registration::reg_status_array()
-            );
-            $default_reg_status->_construct_finalize(
-                'Event_Meta',
-                'EVT_default_registration_status',
-                'EEM_Event'
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
-        }
-    }
-
-
-    /**
-     * Used to override the default for the additional limit field.
-     *
-     * @param $additional_limit
-     */
-    public static function set_default_additional_limit($additional_limit)
-    {
-        self::$_default_additional_limit = (int) $additional_limit;
-        if (self::$_instance instanceof EEM_Event) {
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
-                'EVT_additional_limit',
-                esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
-                false,
-                self::$_default_additional_limit
-            );
-            self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
-                'Event_Meta',
-                'EVT_additional_limit',
-                'EEM_Event'
-            );
-        }
-    }
-
-
-    /**
-     * Return what is currently set as the default additional limit for the event.
-     *
-     * @return int
-     */
-    public static function get_default_additional_limit()
-    {
-        return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_question_groups()
-    {
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                ['QSG_deleted' => false],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int $EVT_ID
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_question_groups($EVT_ID = 0)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
-            [
-                ['EVT_ID' => $EVT_ID],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int     $EVT_ID
-     * @param boolean $for_primary_attendee
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws ReflectionException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     */
-    public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
-    {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                // @codingStandardsIgnoreStart
-                    'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
-                    // @codingStandardsIgnoreEnd
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        $query_params = [
-            [
-                'EVT_ID'                                                                         => $EVT_ID,
-                EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
-            ],
-        ];
-        if ($for_primary_attendee) {
-            $query_params[0]['EQG_primary'] = true;
-        } else {
-            $query_params[0]['EQG_additional'] = true;
-        }
-        return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
-    }
-
-
-    /**
-     * get_question_groups
-     *
-     * @param int             $EVT_ID
-     * @param EE_Registration $registration
-     * @return array|bool
-     * @throws EE_Error
-     * @throws InvalidArgumentException
-     * @throws InvalidDataTypeException
-     * @throws InvalidInterfaceException
-     * @throws ReflectionException
-     */
-    public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
-    {
-        if (! absint($EVT_ID)) {
-            EE_Error::add_error(
-                esc_html__(
-                    'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
-                    'event_espresso'
-                ),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Group')->get_all(
-            [
-                [
-                    'Event_Question_Group.EVT_ID' => $EVT_ID,
-                    'Event_Question_Group.'
-                    . EEM_Event_Question_Group::instance()->fieldNameForContext(
-                        $registration->is_primary_registrant()
-                    )                             => true,
-                ],
-                'order_by' => ['QSG_order' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * get_question_target_db_column
-     *
-     * @param string $QSG_IDs csv list of $QSG IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_questions_in_groups($QSG_IDs = '')
-    {
-        if (empty($QSG_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question')->get_all(
-            [
-                [
-                    'Question_Group.QSG_ID' => ['IN', $QSG_IDs],
-                    'QST_deleted'           => false,
-                    'QST_admin_only'        => is_admin(),
-                ],
-                'order_by' => 'QST_order',
-            ]
-        );
-    }
-
-
-    /**
-     * get_options_for_question
-     *
-     * @param string $QST_IDs csv list of $QST IDs
-     * @return array|bool
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_options_for_question($QST_IDs)
-    {
-        if (empty($QST_IDs)) {
-            EE_Error::add_error(
-                esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
-                __FILE__,
-                __FUNCTION__,
-                __LINE__
-            );
-            return false;
-        }
-        return EE_Registry::instance()->load_model('Question_Option')->get_all(
-            [
-                [
-                    'Question.QST_ID' => ['IN', $QST_IDs],
-                    'QSO_deleted'     => false,
-                ],
-                'order_by' => 'QSO_ID',
-            ]
-        );
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have event start time earlier than now and an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start******'] = [
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = [
-                '<',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        $where_params = $this->set_where_conditions_for_end_datetime($where_params);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * get all events that are published and have an event start time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (Note that status and DTT_EVT_start will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['Datetime.DTT_EVT_start*****'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        } else {
-            $where_params['Datetime.DTT_EVT_start'] = [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
-            ];
-        }
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * Gets all events that are published
-     * and have an event end time later than now
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_active_and_upcoming_events($query_params, $count = false)
-    {
-        if (array_key_exists(0, $query_params)) {
-            $where_params = $query_params[0];
-            unset($query_params[0]);
-        } else {
-            $where_params = [];
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // add status query
-        $where_params = $this->set_where_conditions_for_status($where_params);
-        // add where params for DTT_EVT_end
-        $where_params = $this->set_where_conditions_for_end_datetime($where_params);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * This only returns events that are expired.
-     * They may still be published but all their datetimes have expired.
-     *
-     * @param array $query_params  An array of query params to further filter on
-     *                             (note that status and DTT_EVT_end will be overridden)
-     * @param bool  $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_expired_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0])
-            ? $query_params[0]
-            : [];
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // first get all events that have datetimes where its not expired.
-        $event_ids = $this->get_all_not_expired_event_ids($query_params);
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $and_condition = [
-            'Datetime.DTT_EVT_end' => ['<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')],
-            'EVT_ID'               => ['NOT IN', $event_ids],
-        ];
-        if (isset($where_params['OR'])) {
-            $and_condition['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        // merge remaining $where params with the and conditions.
-        $where_params['AND'] = array_merge($and_condition, $where_params);
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return int[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_not_expired_event_ids(array $query_params = []): array
-    {
-        $query_params[0] = [
-            'Datetime.DTT_EVT_end' => [
-                '>',
-                EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-            ],
-        ];
-        $event_ids       = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
-        return array_keys($event_ids);
-    }
-
-
-    /**
-     * This basically just returns the events that do not have the publish status.
-     *
-     * @param array   $query_params  An array of query params to further filter on
-     *                               (note that status will be overwritten)
-     * @param boolean $count         whether to return the count or not (default FALSE)
-     * @return EE_Event[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_inactive_events($query_params, $count = false)
-    {
-        $where_params = isset($query_params[0])
-            ? $query_params[0]
-            : [];
-        // let's add in specific query_params for inactive events.
-        if (isset($where_params['status'])) {
-            unset($where_params['status']);
-        }
-        // if we have count make sure we don't include group by
-        if ($count && isset($query_params['group_by'])) {
-            unset($query_params['group_by']);
-        }
-        // if we have any additional query_params, let's add them to the 'AND' condition
-        $where_params['AND']['status'] = ['!=', 'publish'];
-        if (isset($where_params['OR'])) {
-            $where_params['AND']['OR'] = $where_params['OR'];
-            unset($where_params['OR']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_end'])) {
-            $where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
-            unset($where_params['Datetime.DTT_EVT_end']);
-        }
-        if (isset($where_params['Datetime.DTT_EVT_start'])) {
-            $where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
-            unset($where_params['Datetime.DTT_EVT_start']);
-        }
-        return $this->_get_count_or_all($query_params, $where_params, $count);
-    }
-
-
-    /**
-     * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
-     * because we don't want to override any existing global default prices but instead insert NEW prices that get
-     * attached to the event. See parent for param descriptions
-     *
-     * @param        $id_or_obj
-     * @param        $other_model_id_or_obj
-     * @param string $relationName
-     * @param array  $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
-    {
-        if ($relationName === 'Price') {
-            // let's get the PRC object for the given ID to make sure that we aren't dealing with a default
-            $prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
-            // if EVT_ID = 0, then this is a default
-            if ((int) $prc_chk->get('EVT_ID') === 0) {
-                // let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
-                $prc_chk->set('PRC_ID', 0);
-            }
-            // run parent
-            return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
-        }
-        // otherwise carry on as normal
-        return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
-    }
-
-
-    /**
-     * @param array $where_params
-     * @return array
-     */
-    public function set_where_conditions_for_status(array $where_params): array
-    {
-        // let's add specific query_params for active_events
-        // keep in mind this will override any sent status in the query AND any date queries.
-        // we need to pull events with a status of publish and sold_out
-        $event_status = ['publish', EEM_Event::sold_out];
-        // check if the user can read private events and if so add the 'private status to the where params'
-        if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
-            $event_status[] = 'private';
-        }
-        $where_params['status'] = ['IN', $event_status];
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $where_params
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function set_where_conditions_for_end_datetime(array $where_params): array
-    {
-        $end_date_field_name = isset($where_params['Datetime.DTT_EVT_end'])
-            ? 'Datetime.DTT_EVT_end*****'
-            // prevents overwrite of existing where condition
-            : 'Datetime.DTT_EVT_end';
-
-        $where_params[ $end_date_field_name ] = [
-            '>',
-            EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
-        ];
-
-        return $where_params;
-    }
-
-
-    /**
-     * @param array $query_params
-     * @param array $where_params
-     * @param bool  $count
-     * @return EE_Soft_Delete_Base_Class[]|int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    protected function _get_count_or_all(array $query_params, array $where_params, bool $count = false)
-    {
-        $query_params[0] = $where_params;
-        // don't use $query_params with count()
-        // because we don't want to include additional query clauses like "GROUP BY"
-        return $count
-            ? $this->count([$where_params], 'EVT_ID', true)
-            : $this->get_all($query_params);
-    }
-
-
-    /******************** DEPRECATED METHODS ********************/
-
-
-    /**
-     * _get_question_target_db_column
-     *
-     * @param EE_Registration $registration    (so existing answers for registration are included)
-     * @param int             $EVT_ID          so all question groups are included for event (not just answers from
-     *                                         registration).
-     * @return    array
-     * @throws ReflectionException
-     * @throws EE_Error
-     * @deprecated as of 4.8.32.rc.001. Instead consider using
-     *                                         EE_Registration_Custom_Questions_Form located in
-     *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
-     * @access     public
-     */
-    public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
-    {
-        if (empty($EVT_ID)) {
-            throw new EE_Error(
-                esc_html__(
-                    'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
-                    'event_espresso'
-                )
-            );
-        }
-        $questions = [];
-        // get all question groups for event
-        $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
-            foreach ($qgs as $qg) {
-                $qsts                                    = $qg->questions();
-                $questions[ $qg->ID() ]                  = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = [];
-                foreach ($qsts as $qst) {
-                    if ($qst->is_system_question()) {
-                        continue;
-                    }
-                    $answer                                                                   =
-                        EEM_Answer::instance()->get_one(
-                            [
-                                [
-                                    'QST_ID' => $qst->ID(),
-                                    'REG_ID' => $registration->ID(),
-                                ],
-                            ]
-                        );
-                    $answer                                                                   =
-                        $answer instanceof EE_Answer
-                            ? $answer
-                            : EEM_Answer::instance()->create_default_object();
-                    $qst_name                                                                 = $qstn_id = $qst->ID();
-                    $ans_id                                                                   = $answer->ID();
-                    $qst_name                                                                 = ! empty($ans_id)
-                        ? '[' . $qst_name . '][' . $ans_id . ']'
-                        : '[' . $qst_name . ']';
-                    $input_name                                                               = '';
-                    $input_id                                                                 =
-                        sanitize_key($qst->display_text());
-                    $input_class                                                              = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]                    =
-                        $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name']  = 'qstn'
-                                                                                                . $input_name
-                                                                                                . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id']    =
-                        $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options']     = [];
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj']         = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj']         = $answer;
-                    // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
-                    if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
-                        $QSOs = $qst->options(true, $answer->value());
-                        if (is_array($QSOs)) {
-                            foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] =
-                                    $QSO->model_field_array();
-                            }
-                        }
-                    }
-                }
-            }
-        }
-        return $questions;
-    }
-
-
-    /**
-     * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
-     *                             or an stdClass where each property is the name of a column,
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function instantiate_class_from_array_or_object($cols_n_values)
-    {
-        $classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
-        if ($classInstance instanceof EE_Event) {
-            // events have their timezone defined in the DB, so use it immediately
-            $this->set_timezone($classInstance->get_timezone());
-        }
-        return $classInstance;
-    }
+	/**
+	 * constant used by status(), indicating that no more tickets can be purchased for any of the datetimes for the
+	 * event
+	 */
+	const sold_out = 'sold_out';
+
+	/**
+	 * constant used by status(), indicating that upcoming event dates have been postponed (may be pushed to a later
+	 * date)
+	 */
+	const postponed = 'postponed';
+
+	/**
+	 * constant used by status(), indicating that the event will no longer occur
+	 */
+	const cancelled = 'cancelled';
+
+
+	/**
+	 * @var string
+	 */
+	protected static $_default_reg_status;
+
+
+	/**
+	 * This is the default for the additional limit field.
+	 *
+	 * @var int
+	 */
+	protected static $_default_additional_limit = 10;
+
+
+	/**
+	 * private instance of the Event object
+	 *
+	 * @var EEM_Event
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * Adds a relationship to Term_Taxonomy for each CPT_Base
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		EE_Registry::instance()->load_model('Registration');
+		$this->singular_item = esc_html__('Event', 'event_espresso');
+		$this->plural_item   = esc_html__('Events', 'event_espresso');
+		// to remove Cancelled events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__cancelled__Public', '__return_false' );
+		// to remove Postponed events from the frontend, copy the following filter to your functions.php file
+		// add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
+		// to remove Sold Out events from the frontend, copy the following filter to your functions.php file
+		//  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
+		$this->_custom_stati       = apply_filters(
+			'AFEE__EEM_Event__construct___custom_stati',
+			[
+				EEM_Event::cancelled => [
+					'label'  => esc_html__('Cancelled', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__cancelled__Public', true),
+				],
+				EEM_Event::postponed => [
+					'label'  => esc_html__('Postponed', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__postponed__Public', true),
+				],
+				EEM_Event::sold_out  => [
+					'label'  => esc_html__('Sold Out', 'event_espresso'),
+					'public' => apply_filters('AFEE__EEM_Event__construct___custom_stati__sold_out__Public', true),
+				],
+			]
+		);
+		self::$_default_reg_status = empty(self::$_default_reg_status)
+			? EEM_Registration::status_id_pending_payment
+			: self::$_default_reg_status;
+		$this->_tables             = [
+			'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
+		];
+		$this->_fields             = [
+			'Event_CPT'  => [
+				'EVT_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__('Post ID for Event', 'event_espresso')
+				),
+				'EVT_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__('Event Name', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__('Event Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_slug'       => new EE_Slug_Field(
+					'post_name',
+					esc_html__('Event Slug', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__('Date/Time Event Created', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_short_desc' => new EE_Simple_HTML_Field(
+					'post_excerpt',
+					esc_html__('Event Short Description', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__('Date/Time Event Modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now
+				),
+				'EVT_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__('Event Creator ID', 'event_espresso'),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__('Event Parent ID', 'event_espresso'),
+					false,
+					0
+				),
+				'EVT_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__('Event Menu Order', 'event_espresso'),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_events'),
+				// EE_Plain_Text_Field( 'post_type', esc_html__( 'Event Post Type', 'event_espresso' ), FALSE, 'espresso_events' ),
+				'status'         => new EE_WP_Post_Status_Field(
+					'post_status',
+					esc_html__('Event Status', 'event_espresso'),
+					false,
+					'draft',
+					$this->_custom_stati
+				),
+				'password'       => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					[
+						'EVT_desc',
+						'EVT_short_desc',
+						'EVT_display_desc',
+						'EVT_display_ticket_selector',
+						'EVT_visible_on',
+						'EVT_additional_limit',
+						'EVT_default_registration_status',
+						'EVT_member_only',
+						'EVT_phone',
+						'EVT_allow_overflow',
+						'EVT_timezone_string',
+						'EVT_external_URL',
+						'EVT_donations',
+					]
+				),
+			],
+			'Event_Meta' => [
+				'EVTM_ID'                         => new EE_DB_Only_Float_Field(
+					'EVTM_ID',
+					esc_html__('Event Meta Row ID', 'event_espresso'),
+					false
+				),
+				'EVT_ID_fk'                       => new EE_DB_Only_Int_Field(
+					'EVT_ID',
+					esc_html__('Foreign key to Event ID from Event Meta table', 'event_espresso'),
+					false
+				),
+				'VNU_ID'                          => new EE_Foreign_Key_Int_Field(
+					'VNU_ID',
+					__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'EVT_display_desc'                => new EE_Boolean_Field(
+					'EVT_display_desc',
+					esc_html__('Display Description Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_display_ticket_selector'     => new EE_Boolean_Field(
+					'EVT_display_ticket_selector',
+					esc_html__('Display Ticket Selector Flag', 'event_espresso'),
+					false,
+					true
+				),
+				'EVT_visible_on'                  => new EE_Datetime_Field(
+					'EVT_visible_on',
+					esc_html__('Event Visible Date', 'event_espresso'),
+					true,
+					EE_Datetime_Field::now
+				),
+				'EVT_additional_limit'            => new EE_Integer_Field(
+					'EVT_additional_limit',
+					esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+					false,
+					self::$_default_additional_limit
+				),
+				'EVT_default_registration_status' => new EE_Enum_Text_Field(
+					'EVT_default_registration_status',
+					esc_html__('Default Registration Status on this Event', 'event_espresso'),
+					false,
+					EEM_Event::$_default_reg_status,
+					EEM_Registration::reg_status_array()
+				),
+				'EVT_member_only'                 => new EE_Boolean_Field(
+					'EVT_member_only',
+					esc_html__('Member-Only Event Flag', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_phone'                       => new EE_Plain_Text_Field(
+					'EVT_phone',
+					esc_html__('Event Phone Number', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_allow_overflow'              => new EE_Boolean_Field(
+					'EVT_allow_overflow',
+					esc_html__('Allow Overflow on Event', 'event_espresso'),
+					false,
+					false
+				),
+				'EVT_timezone_string'             => new EE_Plain_Text_Field(
+					'EVT_timezone_string',
+					esc_html__('Timezone (name) for Event times', 'event_espresso'),
+					false,
+					''
+				),
+				'EVT_external_URL'                => new EE_Plain_Text_Field(
+					'EVT_external_URL',
+					esc_html__('URL of Event Page if hosted elsewhere', 'event_espresso'),
+					true
+				),
+				'EVT_donations'                   => new EE_Boolean_Field(
+					'EVT_donations',
+					esc_html__('Accept Donations?', 'event_espresso'),
+					false,
+					false
+				),
+				'FSC_UUID'                        => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Registration Form UUID (universally unique identifier)', 'event_espresso'),
+					true,
+					null,
+					'Form_Section',
+					false
+				),
+			],
+		];
+		$this->_model_relations    = [
+			'Attendee'               => new EE_HABTM_Relation('Registration'),
+			'Datetime'               => new EE_Has_Many_Relation(),
+			'Event_Question_Group'   => new EE_Has_Many_Relation(),
+			'Form_Section'           => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_HABTM_Relation('Event_Message_Template'),
+			'Question_Group'         => new EE_HABTM_Relation('Event_Question_Group'),
+			'Registration'           => new EE_Has_Many_Relation(),
+			'Term_Relationship'      => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'          => new EE_HABTM_Relation('Term_Relationship'),
+			'Venue'                  => new EE_Belongs_To_Relation(),
+			'WP_User'                => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		$this->model_chain_to_password                            = '';
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * @param string $default_reg_status
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public static function set_default_reg_status($default_reg_status)
+	{
+		self::$_default_reg_status = $default_reg_status;
+		// if EEM_Event has already been instantiated,
+		// then we need to reset the `EVT_default_reg_status` field to use the new default.
+		if (self::$_instance instanceof EEM_Event) {
+			$default_reg_status = new EE_Enum_Text_Field(
+				'EVT_default_registration_status',
+				esc_html__('Default Registration Status on this Event', 'event_espresso'),
+				false,
+				$default_reg_status,
+				EEM_Registration::reg_status_array()
+			);
+			$default_reg_status->_construct_finalize(
+				'Event_Meta',
+				'EVT_default_registration_status',
+				'EEM_Event'
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_default_registration_status'] = $default_reg_status;
+		}
+	}
+
+
+	/**
+	 * Used to override the default for the additional limit field.
+	 *
+	 * @param $additional_limit
+	 */
+	public static function set_default_additional_limit($additional_limit)
+	{
+		self::$_default_additional_limit = (int) $additional_limit;
+		if (self::$_instance instanceof EEM_Event) {
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit'] = new EE_Integer_Field(
+				'EVT_additional_limit',
+				esc_html__('Limit of Additional Registrations on Same Transaction', 'event_espresso'),
+				false,
+				self::$_default_additional_limit
+			);
+			self::$_instance->_fields['Event_Meta']['EVT_additional_limit']->_construct_finalize(
+				'Event_Meta',
+				'EVT_additional_limit',
+				'EEM_Event'
+			);
+		}
+	}
+
+
+	/**
+	 * Return what is currently set as the default additional limit for the event.
+	 *
+	 * @return int
+	 */
+	public static function get_default_additional_limit()
+	{
+		return apply_filters('FHEE__EEM_Event__get_default_additional_limit', self::$_default_additional_limit);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_question_groups()
+	{
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				['QSG_deleted' => false],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int $EVT_ID
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_question_groups($EVT_ID = 0)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all(
+			[
+				['EVT_ID' => $EVT_ID],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int     $EVT_ID
+	 * @param boolean $for_primary_attendee
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws ReflectionException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 */
+	public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
+	{
+		if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+				// @codingStandardsIgnoreStart
+					'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
+					// @codingStandardsIgnoreEnd
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		$query_params = [
+			[
+				'EVT_ID'                                                                         => $EVT_ID,
+				EEM_Event_Question_Group::instance()->fieldNameForContext($for_primary_attendee) => true,
+			],
+		];
+		if ($for_primary_attendee) {
+			$query_params[0]['EQG_primary'] = true;
+		} else {
+			$query_params[0]['EQG_additional'] = true;
+		}
+		return EE_Registry::instance()->load_model('Event_Question_Group')->get_all($query_params);
+	}
+
+
+	/**
+	 * get_question_groups
+	 *
+	 * @param int             $EVT_ID
+	 * @param EE_Registration $registration
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws InvalidArgumentException
+	 * @throws InvalidDataTypeException
+	 * @throws InvalidInterfaceException
+	 * @throws ReflectionException
+	 */
+	public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
+	{
+		if (! absint($EVT_ID)) {
+			EE_Error::add_error(
+				esc_html__(
+					'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
+					'event_espresso'
+				),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Group')->get_all(
+			[
+				[
+					'Event_Question_Group.EVT_ID' => $EVT_ID,
+					'Event_Question_Group.'
+					. EEM_Event_Question_Group::instance()->fieldNameForContext(
+						$registration->is_primary_registrant()
+					)                             => true,
+				],
+				'order_by' => ['QSG_order' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * get_question_target_db_column
+	 *
+	 * @param string $QSG_IDs csv list of $QSG IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_questions_in_groups($QSG_IDs = '')
+	{
+		if (empty($QSG_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question Group IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question')->get_all(
+			[
+				[
+					'Question_Group.QSG_ID' => ['IN', $QSG_IDs],
+					'QST_deleted'           => false,
+					'QST_admin_only'        => is_admin(),
+				],
+				'order_by' => 'QST_order',
+			]
+		);
+	}
+
+
+	/**
+	 * get_options_for_question
+	 *
+	 * @param string $QST_IDs csv list of $QST IDs
+	 * @return array|bool
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_options_for_question($QST_IDs)
+	{
+		if (empty($QST_IDs)) {
+			EE_Error::add_error(
+				esc_html__('An error occurred. No Question IDs were received.', 'event_espresso'),
+				__FILE__,
+				__FUNCTION__,
+				__LINE__
+			);
+			return false;
+		}
+		return EE_Registry::instance()->load_model('Question_Option')->get_all(
+			[
+				[
+					'Question.QST_ID' => ['IN', $QST_IDs],
+					'QSO_deleted'     => false,
+				],
+				'order_by' => 'QSO_ID',
+			]
+		);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have event start time earlier than now and an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_start and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// if already have where params for DTT_EVT_start or DTT_EVT_end then append these conditions
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start******'] = [
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = [
+				'<',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		$where_params = $this->set_where_conditions_for_end_datetime($where_params);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * get all events that are published and have an event start time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (Note that status and DTT_EVT_start will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// if there are already query_params matching DTT_EVT_start then we need to modify that to add them.
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['Datetime.DTT_EVT_start*****'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		} else {
+			$where_params['Datetime.DTT_EVT_start'] = [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_start'),
+			];
+		}
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * Gets all events that are published
+	 * and have an event end time later than now
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_active_and_upcoming_events($query_params, $count = false)
+	{
+		if (array_key_exists(0, $query_params)) {
+			$where_params = $query_params[0];
+			unset($query_params[0]);
+		} else {
+			$where_params = [];
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// add status query
+		$where_params = $this->set_where_conditions_for_status($where_params);
+		// add where params for DTT_EVT_end
+		$where_params = $this->set_where_conditions_for_end_datetime($where_params);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * This only returns events that are expired.
+	 * They may still be published but all their datetimes have expired.
+	 *
+	 * @param array $query_params  An array of query params to further filter on
+	 *                             (note that status and DTT_EVT_end will be overridden)
+	 * @param bool  $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_expired_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0])
+			? $query_params[0]
+			: [];
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// first get all events that have datetimes where its not expired.
+		$event_ids = $this->get_all_not_expired_event_ids($query_params);
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$and_condition = [
+			'Datetime.DTT_EVT_end' => ['<', EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end')],
+			'EVT_ID'               => ['NOT IN', $event_ids],
+		];
+		if (isset($where_params['OR'])) {
+			$and_condition['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$and_condition['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$and_condition['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		// merge remaining $where params with the and conditions.
+		$where_params['AND'] = array_merge($and_condition, $where_params);
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return int[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_not_expired_event_ids(array $query_params = []): array
+	{
+		$query_params[0] = [
+			'Datetime.DTT_EVT_end' => [
+				'>',
+				EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+			],
+		];
+		$event_ids       = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
+		return array_keys($event_ids);
+	}
+
+
+	/**
+	 * This basically just returns the events that do not have the publish status.
+	 *
+	 * @param array   $query_params  An array of query params to further filter on
+	 *                               (note that status will be overwritten)
+	 * @param boolean $count         whether to return the count or not (default FALSE)
+	 * @return EE_Event[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_inactive_events($query_params, $count = false)
+	{
+		$where_params = isset($query_params[0])
+			? $query_params[0]
+			: [];
+		// let's add in specific query_params for inactive events.
+		if (isset($where_params['status'])) {
+			unset($where_params['status']);
+		}
+		// if we have count make sure we don't include group by
+		if ($count && isset($query_params['group_by'])) {
+			unset($query_params['group_by']);
+		}
+		// if we have any additional query_params, let's add them to the 'AND' condition
+		$where_params['AND']['status'] = ['!=', 'publish'];
+		if (isset($where_params['OR'])) {
+			$where_params['AND']['OR'] = $where_params['OR'];
+			unset($where_params['OR']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_end'])) {
+			$where_params['AND']['Datetime.DTT_EVT_end****'] = $where_params['Datetime.DTT_EVT_end'];
+			unset($where_params['Datetime.DTT_EVT_end']);
+		}
+		if (isset($where_params['Datetime.DTT_EVT_start'])) {
+			$where_params['AND']['Datetime.DTT_EVT_start'] = $where_params['Datetime.DTT_EVT_start'];
+			unset($where_params['Datetime.DTT_EVT_start']);
+		}
+		return $this->_get_count_or_all($query_params, $where_params, $count);
+	}
+
+
+	/**
+	 * This is just injecting into the parent add_relationship_to so we do special handling on price relationships
+	 * because we don't want to override any existing global default prices but instead insert NEW prices that get
+	 * attached to the event. See parent for param descriptions
+	 *
+	 * @param        $id_or_obj
+	 * @param        $other_model_id_or_obj
+	 * @param string $relationName
+	 * @param array  $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query = [])
+	{
+		if ($relationName === 'Price') {
+			// let's get the PRC object for the given ID to make sure that we aren't dealing with a default
+			$prc_chk = $this->get_related_model_obj($relationName)->ensure_is_obj($other_model_id_or_obj);
+			// if EVT_ID = 0, then this is a default
+			if ((int) $prc_chk->get('EVT_ID') === 0) {
+				// let's set the prc_id as 0 so we force an insert on the add_relation_to carried out by relation
+				$prc_chk->set('PRC_ID', 0);
+			}
+			// run parent
+			return parent::add_relationship_to($id_or_obj, $prc_chk, $relationName, $where_query);
+		}
+		// otherwise carry on as normal
+		return parent::add_relationship_to($id_or_obj, $other_model_id_or_obj, $relationName, $where_query);
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @return array
+	 */
+	public function set_where_conditions_for_status(array $where_params): array
+	{
+		// let's add specific query_params for active_events
+		// keep in mind this will override any sent status in the query AND any date queries.
+		// we need to pull events with a status of publish and sold_out
+		$event_status = ['publish', EEM_Event::sold_out];
+		// check if the user can read private events and if so add the 'private status to the where params'
+		if (EE_Registry::instance()->CAP->current_user_can('ee_read_private_events', 'get_upcoming_events')) {
+			$event_status[] = 'private';
+		}
+		$where_params['status'] = ['IN', $event_status];
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $where_params
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function set_where_conditions_for_end_datetime(array $where_params): array
+	{
+		$end_date_field_name = isset($where_params['Datetime.DTT_EVT_end'])
+			? 'Datetime.DTT_EVT_end*****'
+			// prevents overwrite of existing where condition
+			: 'Datetime.DTT_EVT_end';
+
+		$where_params[ $end_date_field_name ] = [
+			'>',
+			EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
+		];
+
+		return $where_params;
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @param array $where_params
+	 * @param bool  $count
+	 * @return EE_Soft_Delete_Base_Class[]|int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	protected function _get_count_or_all(array $query_params, array $where_params, bool $count = false)
+	{
+		$query_params[0] = $where_params;
+		// don't use $query_params with count()
+		// because we don't want to include additional query clauses like "GROUP BY"
+		return $count
+			? $this->count([$where_params], 'EVT_ID', true)
+			: $this->get_all($query_params);
+	}
+
+
+	/******************** DEPRECATED METHODS ********************/
+
+
+	/**
+	 * _get_question_target_db_column
+	 *
+	 * @param EE_Registration $registration    (so existing answers for registration are included)
+	 * @param int             $EVT_ID          so all question groups are included for event (not just answers from
+	 *                                         registration).
+	 * @return    array
+	 * @throws ReflectionException
+	 * @throws EE_Error
+	 * @deprecated as of 4.8.32.rc.001. Instead consider using
+	 *                                         EE_Registration_Custom_Questions_Form located in
+	 *                                         admin_pages/registrations/form_sections/EE_Registration_Custom_Questions_Form.form.php
+	 * @access     public
+	 */
+	public function assemble_array_of_groups_questions_and_options(EE_Registration $registration, $EVT_ID = 0)
+	{
+		if (empty($EVT_ID)) {
+			throw new EE_Error(
+				esc_html__(
+					'An error occurred. No EVT_ID is included.  Needed to know which question groups to retrieve.',
+					'event_espresso'
+				)
+			);
+		}
+		$questions = [];
+		// get all question groups for event
+		$qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
+		if (! empty($qgs)) {
+			foreach ($qgs as $qg) {
+				$qsts                                    = $qg->questions();
+				$questions[ $qg->ID() ]                  = $qg->model_field_array();
+				$questions[ $qg->ID() ]['QSG_questions'] = [];
+				foreach ($qsts as $qst) {
+					if ($qst->is_system_question()) {
+						continue;
+					}
+					$answer                                                                   =
+						EEM_Answer::instance()->get_one(
+							[
+								[
+									'QST_ID' => $qst->ID(),
+									'REG_ID' => $registration->ID(),
+								],
+							]
+						);
+					$answer                                                                   =
+						$answer instanceof EE_Answer
+							? $answer
+							: EEM_Answer::instance()->create_default_object();
+					$qst_name                                                                 = $qstn_id = $qst->ID();
+					$ans_id                                                                   = $answer->ID();
+					$qst_name                                                                 = ! empty($ans_id)
+						? '[' . $qst_name . '][' . $ans_id . ']'
+						: '[' . $qst_name . ']';
+					$input_name                                                               = '';
+					$input_id                                                                 =
+						sanitize_key($qst->display_text());
+					$input_class                                                              = '';
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]                    =
+						$qst->model_field_array();
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name']  = 'qstn'
+																								. $input_name
+																								. $qst_name;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id']    =
+						$input_id . '-' . $qstn_id;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options']     = [];
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj']         = $qst;
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj']         = $answer;
+					// leave responses as-is, don't convert stuff into html entities please!
+					$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+					if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
+						$QSOs = $qst->options(true, $answer->value());
+						if (is_array($QSOs)) {
+							foreach ($QSOs as $QSO_ID => $QSO) {
+								$questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] =
+									$QSO->model_field_array();
+							}
+						}
+					}
+				}
+			}
+		}
+		return $questions;
+	}
+
+
+	/**
+	 * @param mixed $cols_n_values either an array of where each key is the name of a field, and the value is its value
+	 *                             or an stdClass where each property is the name of a column,
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function instantiate_class_from_array_or_object($cols_n_values)
+	{
+		$classInstance = parent::instantiate_class_from_array_or_object($cols_n_values);
+		if ($classInstance instanceof EE_Event) {
+			// events have their timezone defined in the DB, so use it immediately
+			$this->set_timezone($classInstance->get_timezone());
+		}
+		return $classInstance;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -71,7 +71,7 @@ 
         // add_filter( 'AFEE__EEM_Event__construct___custom_stati__postponed__Public', '__return_false' );
         // to remove Sold Out events from the frontend, copy the following filter to your functions.php file
         //  add_filter( 'AFEE__EEM_Event__construct___custom_stati__sold_out__Public', '__return_false' );
-        $this->_custom_stati       = apply_filters(
+        $this->_custom_stati = apply_filters(
             'AFEE__EEM_Event__construct___custom_stati',
             [
                 EEM_Event::cancelled => [
@@ -95,7 +95,7 @@ 
             'Event_CPT'  => new EE_Primary_Table('posts', 'ID'),
             'Event_Meta' => new EE_Secondary_Table('esp_event_meta', 'EVTM_ID', 'EVT_ID'),
         ];
-        $this->_fields             = [
+        $this->_fields = [
             'Event_CPT'  => [
                 'EVT_ID'         => new EE_Primary_Key_Int_Field(
                     'ID',
@@ -279,7 +279,7 @@ 
                 ),
             ],
         ];
-        $this->_model_relations    = [
+        $this->_model_relations = [
             'Attendee'               => new EE_HABTM_Relation('Registration'),
             'Datetime'               => new EE_Has_Many_Relation(),
             'Event_Question_Group'   => new EE_Has_Many_Relation(),
@@ -293,7 +293,7 @@ 
             'WP_User'                => new EE_Belongs_To_Relation(),
         ];
         // 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] = new EE_Restriction_Generator_Public();
         $this->model_chain_to_password                            = '';
         parent::__construct($timezone);
     }
@@ -390,7 +390,7 @@ 
      */
     public function get_all_event_question_groups($EVT_ID = 0)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Event Question Groups could be retrieved because an Event ID was not received.',
@@ -424,7 +424,7 @@ 
      */
     public function get_event_question_groups($EVT_ID = 0, $for_primary_attendee = true)
     {
-        if (! isset($EVT_ID) || ! absint($EVT_ID)) {
+        if ( ! isset($EVT_ID) || ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                 // @codingStandardsIgnoreStart
@@ -467,7 +467,7 @@ 
      */
     public function get_question_groups_for_event($EVT_ID, EE_Registration $registration)
     {
-        if (! absint($EVT_ID)) {
+        if ( ! absint($EVT_ID)) {
             EE_Error::add_error(
                 esc_html__(
                     'An error occurred. No Question Groups could be retrieved because an Event ID was not received.',
@@ -734,7 +734,7 @@ 
                 EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
             ],
         ];
-        $event_ids       = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
+        $event_ids = $this->_get_all_wpdb_results($query_params, OBJECT_K, 'Event_CPT.ID');
         return array_keys($event_ids);
     }
 
@@ -843,7 +843,7 @@ 
             // prevents overwrite of existing where condition
             : 'Datetime.DTT_EVT_end';
 
-        $where_params[ $end_date_field_name ] = [
+        $where_params[$end_date_field_name] = [
             '>',
             EEM_Datetime::instance()->current_time_for_query('DTT_EVT_end'),
         ];
@@ -901,16 +901,16 @@ 
         $questions = [];
         // get all question groups for event
         $qgs = $this->get_question_groups_for_event($EVT_ID, $registration);
-        if (! empty($qgs)) {
+        if ( ! empty($qgs)) {
             foreach ($qgs as $qg) {
                 $qsts                                    = $qg->questions();
-                $questions[ $qg->ID() ]                  = $qg->model_field_array();
-                $questions[ $qg->ID() ]['QSG_questions'] = [];
+                $questions[$qg->ID()]                  = $qg->model_field_array();
+                $questions[$qg->ID()]['QSG_questions'] = [];
                 foreach ($qsts as $qst) {
                     if ($qst->is_system_question()) {
                         continue;
                     }
-                    $answer                                                                   =
+                    $answer =
                         EEM_Answer::instance()->get_one(
                             [
                                 [
@@ -919,37 +919,37 @@ 
                                 ],
                             ]
                         );
-                    $answer                                                                   =
+                    $answer =
                         $answer instanceof EE_Answer
                             ? $answer
                             : EEM_Answer::instance()->create_default_object();
                     $qst_name                                                                 = $qstn_id = $qst->ID();
                     $ans_id                                                                   = $answer->ID();
                     $qst_name                                                                 = ! empty($ans_id)
-                        ? '[' . $qst_name . '][' . $ans_id . ']'
-                        : '[' . $qst_name . ']';
+                        ? '['.$qst_name.']['.$ans_id.']'
+                        : '['.$qst_name.']';
                     $input_name                                                               = '';
                     $input_id                                                                 =
                         sanitize_key($qst->display_text());
                     $input_class                                                              = '';
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]                    =
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]                    =
                         $qst->model_field_array();
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_name']  = 'qstn'
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_name']  = 'qstn'
                                                                                                 . $input_name
                                                                                                 . $qst_name;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_id']    =
-                        $input_id . '-' . $qstn_id;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_input_class'] = $input_class;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options']     = [];
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['qst_obj']         = $qst;
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['ans_obj']         = $answer;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_id']    =
+                        $input_id.'-'.$qstn_id;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_input_class'] = $input_class;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options']     = [];
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['qst_obj']         = $qst;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['ans_obj']         = $answer;
                     // leave responses as-is, don't convert stuff into html entities please!
-                    $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['htmlentities'] = false;
+                    $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['htmlentities'] = false;
                     if ($qst->type() == 'RADIO_BTN' || $qst->type() == 'CHECKBOX' || $qst->type() == 'DROPDOWN') {
                         $QSOs = $qst->options(true, $answer->value());
                         if (is_array($QSOs)) {
                             foreach ($QSOs as $QSO_ID => $QSO) {
-                                $questions[ $qg->ID() ]['QSG_questions'][ $qst->ID() ]['QST_options'][ $QSO_ID ] =
+                                $questions[$qg->ID()]['QSG_questions'][$qst->ID()]['QST_options'][$QSO_ID] =
                                     $QSO->model_field_array();
                             }
                         }

core/db_models/EEM_Event_Venue.model.php

Indentation +61 added lines, -61 removed lines

@@ -9,68 +9,68 @@
  */
 class EEM_Event_Venue extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
-        $this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
-        $this->_tables          = [
-            'Event_Venue' => new EE_Primary_Table('esp_event_venue', 'EVV_ID'),
-        ];
-        $this->_fields          = [
-            'Event_Venue' => [
-                'EVV_ID'      => new EE_Primary_Key_Int_Field(
-                    'EVV_ID',
-                    esc_html__('Event to Venue Link 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',
-                    esc_html__('Venue ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Venue'
-                ),
-                'EVV_primary' => new EE_Boolean_Field(
-                    'EVV_primary',
-                    esc_html__(
-                        "Flag indicating venue is primary one for event",
-                        "event_espresso"
-                    ),
-                    false,
-                    true
-                ),
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Event to Question Group Link', 'event_espresso');
+		$this->plural_item      = esc_html__('Event to Question Group Links', 'event_espresso');
+		$this->_tables          = [
+			'Event_Venue' => new EE_Primary_Table('esp_event_venue', 'EVV_ID'),
+		];
+		$this->_fields          = [
+			'Event_Venue' => [
+				'EVV_ID'      => new EE_Primary_Key_Int_Field(
+					'EVV_ID',
+					esc_html__('Event to Venue Link 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',
+					esc_html__('Venue ID', 'event_espresso'),
+					false,
+					0,
+					'Venue'
+				),
+				'EVV_primary' => new EE_Boolean_Field(
+					'EVV_primary',
+					esc_html__(
+						"Flag indicating venue is primary one for event",
+						"event_espresso"
+					),
+					false,
+					true
+				),
 
-            ],
-        ];
-        $this->_model_relations = [
-            'Event' => new EE_Belongs_To_Relation(),
-            'Venue' => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $path_to_event                                                  = '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->_model_relations = [
+			'Event' => new EE_Belongs_To_Relation(),
+			'Venue' => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$path_to_event                                                  = '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);
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -62,13 +62,13 @@
         ];
         // this model is generally available for reading
         $path_to_event                                                  = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $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 ] =
+        $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 ]       =
+        $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 ]     =
+        $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);