eventespresso / event-espresso-core

core/db_models/EEM_Checkin.model.php

Indentation +62 added lines, -62 removed lines

@@ -12,69 +12,69 @@
 class EEM_Checkin extends EEM_Base
 {
 
-    // private instance of the EEM_Checkin object
-    protected static $_instance;
+	// private instance of the EEM_Checkin object
+	protected static $_instance;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              will use 'timezone_string' wp option as default
-     * @return void
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Check-In', 'event_espresso');
-        $this->plural_item   = esc_html__('Check-Ins', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
+	 *                              (and any incoming timezone data that gets saved).
+	 *                              Note this just sends the timezone info to the date time model field objects.
+	 *                              will use 'timezone_string' wp option as default
+	 * @return void
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Check-In', 'event_espresso');
+		$this->plural_item   = esc_html__('Check-Ins', 'event_espresso');
 
-        $this->_tables                 = [
-            'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID'),
-        ];
-        $this->_fields                 = [
-            'Checkin' => [
-                'CHK_ID'        => new EE_Primary_Key_Int_Field(
-                    'CHK_ID',
-                    esc_html__('Check-in ID', 'event_espresso')
-                ),
-                'REG_ID'        => new EE_Foreign_Key_Int_Field(
-                    'REG_ID',
-                    esc_html__('Registration Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Registration'
-                ),
-                'DTT_ID'        => new EE_Foreign_Key_Int_Field(
-                    'DTT_ID',
-                    esc_html__('Datetime Id', 'event_espresso'),
-                    false,
-                    0,
-                    'Datetime'
-                ),
-                'CHK_in'        => new EE_Boolean_Field(
-                    'CHK_in',
-                    esc_html__('Whether a person has checked in or checked out', 'event_espresso'),
-                    false,
-                    true
-                ),
-                'CHK_timestamp' => new EE_Datetime_Field(
-                    'CHK_timestamp',
-                    esc_html__('When the row was modified', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations        = [
-            'Registration' => new EE_Belongs_To_Relation(),
-            'Datetime'     => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user = 'Registration.Event';
-        parent::__construct($timezone);
-    }
+		$this->_tables                 = [
+			'Checkin' => new EE_Primary_Table('esp_checkin', 'CHK_ID'),
+		];
+		$this->_fields                 = [
+			'Checkin' => [
+				'CHK_ID'        => new EE_Primary_Key_Int_Field(
+					'CHK_ID',
+					esc_html__('Check-in ID', 'event_espresso')
+				),
+				'REG_ID'        => new EE_Foreign_Key_Int_Field(
+					'REG_ID',
+					esc_html__('Registration Id', 'event_espresso'),
+					false,
+					0,
+					'Registration'
+				),
+				'DTT_ID'        => new EE_Foreign_Key_Int_Field(
+					'DTT_ID',
+					esc_html__('Datetime Id', 'event_espresso'),
+					false,
+					0,
+					'Datetime'
+				),
+				'CHK_in'        => new EE_Boolean_Field(
+					'CHK_in',
+					esc_html__('Whether a person has checked in or checked out', 'event_espresso'),
+					false,
+					true
+				),
+				'CHK_timestamp' => new EE_Datetime_Field(
+					'CHK_timestamp',
+					esc_html__('When the row was modified', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations        = [
+			'Registration' => new EE_Belongs_To_Relation(),
+			'Datetime'     => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user = 'Registration.Event';
+		parent::__construct($timezone);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -70,7 +70,7 @@
                 ),
             ],
         ];
-        $this->_model_relations        = [
+        $this->_model_relations = [
             'Registration' => new EE_Belongs_To_Relation(),
             'Datetime'     => new EE_Belongs_To_Relation(),
         ];

core/db_models/EEM_Payment.model.php

Indentation +326 added lines, -326 removed lines

@@ -12,330 +12,330 @@
 class EEM_Payment extends EEM_Base implements EEMI_Payment
 {
 
-    /**
-     * @var EEM_Payment
-     */
-    protected static $_instance;
-
-
-    /**
-     * 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';
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string $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 EE_Error
-     */
-    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 int|string $PAY_txn_id_chq_nmbr
-     * @return EE_Payment
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr): EE_Payment
-    {
-        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
-     *
-     * @param int $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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_payments_for_transaction(int $TXN_ID, string $status_of_payment = ''): array
-    {
-        // 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[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_approved_payments_for_transaction(int $TXN_ID = 0): array
-    {
-        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 ReflectionException
-     *
-     * @throws EE_Error
-     */
-    public function get_payments_made_between_dates(
-        string $start_date = '',
-        string $end_date = '',
-        string $format = '',
-        string $timezone = ''
-    ): array {
-        $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(__('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(): string
-    {
-        return self::status_id_approved;
-    }
-
-
-    /**
-     * returns a string for the pending status
-     *
-     * @return  string
-     */
-    public function pending_status(): string
-    {
-        return self::status_id_pending;
-    }
-
-
-    /**
-     * returns a string for the cancelled status
-     *
-     * @return  string
-     */
-    public function cancelled_status(): string
-    {
-        return self::status_id_cancelled;
-    }
-
-
-    /**
-     * returns a string for the failed status
-     *
-     * @return  string
-     */
-    public function failed_status(): string
-    {
-        return self::status_id_failed;
-    }
-
-
-    /**
-     * returns a string for the declined status
-     *
-     * @return  string
-     */
-    public function declined_status(): string
-    {
-        return self::status_id_declined;
-    }
+	/**
+	 * @var EEM_Payment
+	 */
+	protected static $_instance;
+
+
+	/**
+	 * 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';
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string $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 EE_Error
+	 */
+	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 int|string $PAY_txn_id_chq_nmbr
+	 * @return EE_Payment
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_payment_by_txn_id_chq_nmbr($PAY_txn_id_chq_nmbr): EE_Payment
+	{
+		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
+	 *
+	 * @param int $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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_payments_for_transaction(int $TXN_ID, string $status_of_payment = ''): array
+	{
+		// 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[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_approved_payments_for_transaction(int $TXN_ID = 0): array
+	{
+		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 ReflectionException
+	 *
+	 * @throws EE_Error
+	 */
+	public function get_payments_made_between_dates(
+		string $start_date = '',
+		string $end_date = '',
+		string $format = '',
+		string $timezone = ''
+	): array {
+		$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(__('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(): string
+	{
+		return self::status_id_approved;
+	}
+
+
+	/**
+	 * returns a string for the pending status
+	 *
+	 * @return  string
+	 */
+	public function pending_status(): string
+	{
+		return self::status_id_pending;
+	}
+
+
+	/**
+	 * returns a string for the cancelled status
+	 *
+	 * @return  string
+	 */
+	public function cancelled_status(): string
+	{
+		return self::status_id_cancelled;
+	}
+
+
+	/**
+	 * returns a string for the failed status
+	 *
+	 * @return  string
+	 */
+	public function failed_status(): string
+	{
+		return self::status_id_failed;
+	}
+
+
+	/**
+	 * returns a string for the declined status
+	 *
+	 * @return  string
+	 */
+	public function declined_status(): string
+	{
+		return self::status_id_declined;
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -158,7 +158,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(),
@@ -246,7 +246,7 @@ 
     ): array {
         $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(__('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'));
         }
@@ -257,12 +257,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
@@ -271,11 +271,11 @@ 
 
         // 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('PAY_timestamp',
-                                                        date('Y-m-d', $end) . ' 23:59:59',
+        $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());
 

core/db_models/EEM_Venue.model.php

Indentation +203 added lines, -203 removed lines

@@ -10,209 +10,209 @@
 class EEM_Venue extends EEM_CPT_Base
 {
 
-    /**
-     * @var EEM_Venue
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Venue
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Venue constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Venue', 'event_espresso');
-        $this->plural_item      = esc_html__('Venues', 'event_espresso');
-        $this->_tables          = [
-            'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
-            'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
-        ];
-        $this->_fields          = [
-            'Venue_CPT'  => [
-                'VNU_ID'         => new EE_Primary_Key_Int_Field(
-                    'ID',
-                    esc_html__("Venue ID", "event_espresso")
-                ),
-                'VNU_name'       => new EE_Plain_Text_Field(
-                    'post_title',
-                    esc_html__("Venue Name", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_desc'       => new EE_Post_Content_Field(
-                    'post_content',
-                    esc_html__("Venue Description", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_identifier' => new EE_Slug_Field(
-                    'post_name',
-                    esc_html__("Venue Identifier", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'VNU_created'    => new EE_Datetime_Field(
-                    'post_date',
-                    esc_html__("Date Venue Created", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_short_desc' => new EE_Plain_Text_Field(
-                    'post_excerpt',
-                    esc_html__("Short Description of Venue", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_modified'   => new EE_Datetime_Field(
-                    'post_modified',
-                    esc_html__("Venue Modified Date", "event_espresso"),
-                    false,
-                    EE_Datetime_Field::now
-                ),
-                'VNU_wp_user'    => new EE_WP_User_Field(
-                    'post_author',
-                    esc_html__("Venue Creator ID", "event_espresso"),
-                    false
-                ),
-                'parent'         => new EE_Integer_Field(
-                    'post_parent',
-                    esc_html__("Venue Parent ID", "event_espresso"),
-                    false,
-                    0
-                ),
-                'VNU_order'      => new EE_Integer_Field(
-                    'menu_order',
-                    esc_html__("Venue order", "event_espresso"),
-                    false,
-                    1
-                ),
-                'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
-                'password'       => new EE_Password_Field(
-                    'post_password',
-                    esc_html__('Password', 'event_espresso'),
-                    false,
-                    '',
-                    [
-                        'VNU_desc',
-                        'VNU_short_desc',
-                        'VNU_address',
-                        'VNU_address2',
-                        'VNU_city',
-                        'STA_ID',
-                        'CNT_ISO',
-                        'VNU_zip',
-                        'VNU_phone',
-                        'VNU_capacity',
-                        'VNU_url',
-                        'VNU_virtual_phone',
-                        'VNU_virtual_url',
-                        'VNU_google_map_link',
-                        'VNU_enable_for_gmap',
-                    ]
-                ),
-            ],
-            'Venue_Meta' => [
-                'VNUM_ID'             => new EE_DB_Only_Int_Field(
-                    'VNUM_ID',
-                    esc_html__("ID of Venue Meta Row", "event_espresso"),
-                    false
-                ),
-                'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
-                    'VNU_ID',
-                    esc_html__("Foreign Key to Venue Post ", "event_espresso"),
-                    false
-                ),
-                'VNU_address'         => new EE_Plain_Text_Field(
-                    'VNU_address',
-                    esc_html__("Venue Address line 1", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_address2'        => new EE_Plain_Text_Field(
-                    'VNU_address2',
-                    esc_html__("Venue Address line 2", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'VNU_city'            => new EE_Plain_Text_Field(
-                    'VNU_city',
-                    esc_html__("Venue City", "event_espresso"),
-                    true,
-                    ''
-                ),
-                'STA_ID'              => new EE_Foreign_Key_Int_Field(
-                    'STA_ID',
-                    esc_html__("State ID", "event_espresso"),
-                    true,
-                    null,
-                    'State'
-                ),
-                'CNT_ISO'             => new EE_Foreign_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__("Country Code", "event_espresso"),
-                    true,
-                    null,
-                    'Country'
-                ),
-                'VNU_zip'             => new EE_Plain_Text_Field(
-                    'VNU_zip',
-                    esc_html__("Venue Zip/Postal Code", "event_espresso"),
-                    true
-                ),
-                'VNU_phone'           => new EE_Plain_Text_Field(
-                    'VNU_phone',
-                    esc_html__("Venue Phone", "event_espresso"),
-                    true
-                ),
-                'VNU_capacity'        => new EE_Infinite_Integer_Field(
-                    'VNU_capacity',
-                    esc_html__("Venue Capacity", "event_espresso"),
-                    true,
-                    EE_INF
-                ),
-                'VNU_url'             => new EE_Plain_Text_Field(
-                    'VNU_url',
-                    esc_html__('Venue Website', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_phone'   => new EE_Plain_Text_Field(
-                    'VNU_virtual_phone',
-                    esc_html__('Call in Number', 'event_espresso'),
-                    true
-                ),
-                'VNU_virtual_url'     => new EE_Plain_Text_Field(
-                    'VNU_virtual_url',
-                    esc_html__('Virtual URL', 'event_espresso'),
-                    true
-                ),
-                'VNU_google_map_link' => new EE_Plain_Text_Field(
-                    'VNU_google_map_link',
-                    esc_html__('Google Map Link', 'event_espresso'),
-                    true
-                ),
-                'VNU_enable_for_gmap' => new EE_Boolean_Field(
-                    'VNU_enable_for_gmap',
-                    esc_html__('Show Google Map?', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Event'             => new EE_HABTM_Relation('Event_Venue'),
-            'State'             => new EE_Belongs_To_Relation(),
-            'Country'           => new EE_Belongs_To_Relation(),
-            'Event_Venue'       => new EE_Has_Many_Relation(),
-            'WP_User'           => new EE_Belongs_To_Relation(),
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
-        ];
-        // 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);
-    }
+	/**
+	 * EEM_Venue constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Venue', 'event_espresso');
+		$this->plural_item      = esc_html__('Venues', 'event_espresso');
+		$this->_tables          = [
+			'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
+			'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
+		];
+		$this->_fields          = [
+			'Venue_CPT'  => [
+				'VNU_ID'         => new EE_Primary_Key_Int_Field(
+					'ID',
+					esc_html__("Venue ID", "event_espresso")
+				),
+				'VNU_name'       => new EE_Plain_Text_Field(
+					'post_title',
+					esc_html__("Venue Name", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_desc'       => new EE_Post_Content_Field(
+					'post_content',
+					esc_html__("Venue Description", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_identifier' => new EE_Slug_Field(
+					'post_name',
+					esc_html__("Venue Identifier", "event_espresso"),
+					false,
+					''
+				),
+				'VNU_created'    => new EE_Datetime_Field(
+					'post_date',
+					esc_html__("Date Venue Created", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_short_desc' => new EE_Plain_Text_Field(
+					'post_excerpt',
+					esc_html__("Short Description of Venue", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_modified'   => new EE_Datetime_Field(
+					'post_modified',
+					esc_html__("Venue Modified Date", "event_espresso"),
+					false,
+					EE_Datetime_Field::now
+				),
+				'VNU_wp_user'    => new EE_WP_User_Field(
+					'post_author',
+					esc_html__("Venue Creator ID", "event_espresso"),
+					false
+				),
+				'parent'         => new EE_Integer_Field(
+					'post_parent',
+					esc_html__("Venue Parent ID", "event_espresso"),
+					false,
+					0
+				),
+				'VNU_order'      => new EE_Integer_Field(
+					'menu_order',
+					esc_html__("Venue order", "event_espresso"),
+					false,
+					1
+				),
+				'post_type'      => new EE_WP_Post_Type_Field('espresso_venues'),
+				'password'       => new EE_Password_Field(
+					'post_password',
+					esc_html__('Password', 'event_espresso'),
+					false,
+					'',
+					[
+						'VNU_desc',
+						'VNU_short_desc',
+						'VNU_address',
+						'VNU_address2',
+						'VNU_city',
+						'STA_ID',
+						'CNT_ISO',
+						'VNU_zip',
+						'VNU_phone',
+						'VNU_capacity',
+						'VNU_url',
+						'VNU_virtual_phone',
+						'VNU_virtual_url',
+						'VNU_google_map_link',
+						'VNU_enable_for_gmap',
+					]
+				),
+			],
+			'Venue_Meta' => [
+				'VNUM_ID'             => new EE_DB_Only_Int_Field(
+					'VNUM_ID',
+					esc_html__("ID of Venue Meta Row", "event_espresso"),
+					false
+				),
+				'VNU_ID_fk'           => new EE_DB_Only_Int_Field(
+					'VNU_ID',
+					esc_html__("Foreign Key to Venue Post ", "event_espresso"),
+					false
+				),
+				'VNU_address'         => new EE_Plain_Text_Field(
+					'VNU_address',
+					esc_html__("Venue Address line 1", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_address2'        => new EE_Plain_Text_Field(
+					'VNU_address2',
+					esc_html__("Venue Address line 2", "event_espresso"),
+					true,
+					''
+				),
+				'VNU_city'            => new EE_Plain_Text_Field(
+					'VNU_city',
+					esc_html__("Venue City", "event_espresso"),
+					true,
+					''
+				),
+				'STA_ID'              => new EE_Foreign_Key_Int_Field(
+					'STA_ID',
+					esc_html__("State ID", "event_espresso"),
+					true,
+					null,
+					'State'
+				),
+				'CNT_ISO'             => new EE_Foreign_Key_String_Field(
+					'CNT_ISO',
+					esc_html__("Country Code", "event_espresso"),
+					true,
+					null,
+					'Country'
+				),
+				'VNU_zip'             => new EE_Plain_Text_Field(
+					'VNU_zip',
+					esc_html__("Venue Zip/Postal Code", "event_espresso"),
+					true
+				),
+				'VNU_phone'           => new EE_Plain_Text_Field(
+					'VNU_phone',
+					esc_html__("Venue Phone", "event_espresso"),
+					true
+				),
+				'VNU_capacity'        => new EE_Infinite_Integer_Field(
+					'VNU_capacity',
+					esc_html__("Venue Capacity", "event_espresso"),
+					true,
+					EE_INF
+				),
+				'VNU_url'             => new EE_Plain_Text_Field(
+					'VNU_url',
+					esc_html__('Venue Website', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_phone'   => new EE_Plain_Text_Field(
+					'VNU_virtual_phone',
+					esc_html__('Call in Number', 'event_espresso'),
+					true
+				),
+				'VNU_virtual_url'     => new EE_Plain_Text_Field(
+					'VNU_virtual_url',
+					esc_html__('Virtual URL', 'event_espresso'),
+					true
+				),
+				'VNU_google_map_link' => new EE_Plain_Text_Field(
+					'VNU_google_map_link',
+					esc_html__('Google Map Link', 'event_espresso'),
+					true
+				),
+				'VNU_enable_for_gmap' => new EE_Boolean_Field(
+					'VNU_enable_for_gmap',
+					esc_html__('Show Google Map?', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Event'             => new EE_HABTM_Relation('Event_Venue'),
+			'State'             => new EE_Belongs_To_Relation(),
+			'Country'           => new EE_Belongs_To_Relation(),
+			'Event_Venue'       => new EE_Has_Many_Relation(),
+			'WP_User'           => new EE_Belongs_To_Relation(),
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
+		];
+		// 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);
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -30,7 +30,7 @@ 
             'Venue_CPT'  => new EE_Primary_Table('posts', 'ID'),
             'Venue_Meta' => new EE_Secondary_Table('esp_venue_meta', 'VNUM_ID', 'VNU_ID'),
         ];
-        $this->_fields          = [
+        $this->_fields = [
             'Venue_CPT'  => [
                 'VNU_ID'         => new EE_Primary_Key_Int_Field(
                     'ID',
@@ -211,7 +211,7 @@ 
             'Term_Taxonomy'     => new EE_HABTM_Relation('Term_Relationship'),
         ];
         // 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);
     }

core/db_models/EEM_Extra_Join.model.php

Indentation +58 added lines, -58 removed lines

@@ -21,65 +21,65 @@
  */
 class EEM_Extra_Join extends EEM_Base
 {
-    // private instance of the Extra Join object
-    protected static $_instance;
+	// private instance of the Extra Join object
+	protected static $_instance;
 
 
-    /**
-     * EEM_Extra_Join constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    public function __construct(string $timezone = '')
-    {
-        $models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
-        $this->_tables        = [
-            'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
-        ];
-        $this->_fields        = [
-            'Extra_Join' => [
-                'EXJ_ID'                => new EE_Primary_Key_Int_Field(
-                    'EXJ_ID', esc_html__('Extra Join ID', 'event_espresso')
-                ),
-                'EXJ_first_model_ID'    => new EE_Foreign_Key_String_Field(
-                    'EXJ_first_model_ID',
-                    esc_html__('First Model ID', 'event_espresso'),
-                    true,
-                    0,
-                    $models_this_can_join
-                ),
-                'EXJ_first_model_name'  => new EE_Any_Foreign_Model_Name_Field(
-                    'EXJ_first_model_name',
-                    esc_html__('First Model Name', 'event_espresso'),
-                    true,
-                    '',
-                    $models_this_can_join
-                ),
-                'EXJ_second_model_ID'   => new EE_Foreign_Key_String_Field(
-                    'EXJ_second_model_ID',
-                    esc_html__('Second Model ID', 'event_espresso'),
-                    true,
-                    0,
-                    $models_this_can_join
-                ),
-                'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field(
-                    'EXJ_second_model_name',
-                    esc_html__('Second Model Name', 'event_espresso'),
-                    true,
-                    '',
-                    $models_this_can_join
-                ),
+	/**
+	 * EEM_Extra_Join constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	public function __construct(string $timezone = '')
+	{
+		$models_this_can_join = array_keys(EE_Registry::instance()->non_abstract_db_models);
+		$this->_tables        = [
+			'Extra_Join' => new EE_Primary_Table('esp_extra_join', 'EXJ_ID'),
+		];
+		$this->_fields        = [
+			'Extra_Join' => [
+				'EXJ_ID'                => new EE_Primary_Key_Int_Field(
+					'EXJ_ID', esc_html__('Extra Join ID', 'event_espresso')
+				),
+				'EXJ_first_model_ID'    => new EE_Foreign_Key_String_Field(
+					'EXJ_first_model_ID',
+					esc_html__('First Model ID', 'event_espresso'),
+					true,
+					0,
+					$models_this_can_join
+				),
+				'EXJ_first_model_name'  => new EE_Any_Foreign_Model_Name_Field(
+					'EXJ_first_model_name',
+					esc_html__('First Model Name', 'event_espresso'),
+					true,
+					'',
+					$models_this_can_join
+				),
+				'EXJ_second_model_ID'   => new EE_Foreign_Key_String_Field(
+					'EXJ_second_model_ID',
+					esc_html__('Second Model ID', 'event_espresso'),
+					true,
+					0,
+					$models_this_can_join
+				),
+				'EXJ_second_model_name' => new EE_Any_Foreign_Model_Name_Field(
+					'EXJ_second_model_name',
+					esc_html__('Second Model Name', 'event_espresso'),
+					true,
+					'',
+					$models_this_can_join
+				),
 
-            ],
-        ];
-        // this model is weird in that it has two foreign key columns which can point to any model/table.
-        // eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
-        // model linked to is alphabetically greater than event (eg venue).
-        // but if the model linked to is alphabetically lower (eg attendee),
-        // the foreign key to the event will be in "EXJ_second_model_ID"
-        // so normal usage of foreign keys is weird. So don't define any
-        // relations to other models because they won't work properly with this model
-        parent::__construct($timezone);
-    }
+			],
+		];
+		// this model is weird in that it has two foreign key columns which can point to any model/table.
+		// eg a foreign key to event will be in "EXJ_first_model_ID", provided the other
+		// model linked to is alphabetically greater than event (eg venue).
+		// but if the model linked to is alphabetically lower (eg attendee),
+		// the foreign key to the event will be in "EXJ_second_model_ID"
+		// so normal usage of foreign keys is weird. So don't define any
+		// relations to other models because they won't work properly with this model
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_State.model.php

Indentation +209 added lines, -209 removed lines

@@ -10,213 +10,213 @@
 class EEM_State extends EEM_Base
 {
 
-    /**
-     * @var EEM_State
-     */
-    protected static $_instance;
-
-    /**
-     * @var EE_State[]
-     */
-    private static $_all_states;
-
-    /**
-     * @var EE_State[]
-     */
-    private static $_active_states;
-
-
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('State/Province', 'event_espresso');
-        $this->plural_item   = esc_html__('States/Provinces', 'event_espresso');
-
-        $this->_tables = [
-            'State' => new EE_Primary_Table('esp_state', 'STA_ID'),
-        ];
-
-        $this->_fields          = [
-            'State' => [
-                'STA_ID'     => new EE_Primary_Key_Int_Field(
-                    'STA_ID',
-                    esc_html__('State ID', 'event_espresso')
-                ),
-                'CNT_ISO'    => new EE_Foreign_Key_String_Field(
-                    'CNT_ISO',
-                    esc_html__('Country ISO Code', 'event_espresso'),
-                    false,
-                    null,
-                    'Country'
-                ),
-                'STA_abbrev' => new EE_Plain_Text_Field(
-                    'STA_abbrev',
-                    esc_html__('State Abbreviation', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'STA_name'   => new EE_Plain_Text_Field(
-                    'STA_name',
-                    esc_html__('State Name', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'STA_active' => new EE_Boolean_Field(
-                    'STA_active',
-                    esc_html__('State Active Flag', 'event_espresso'),
-                    false,
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Attendee' => new EE_Has_Many_Relation(),
-            'Country'  => new EE_Belongs_To_Relation(),
-            'Venue'    => new EE_Has_Many_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
-        // @todo: only show STA_active
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * reset_cached_states
-     *
-     * @return void
-     */
-    public function reset_cached_states()
-    {
-        EEM_State::$_active_states = null;
-        EEM_State::$_all_states    = null;
-    }
-
-
-    /**
-     * _get_states
-     *
-     * @return EE_State[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_states(): array
-    {
-        if (self::$_all_states === null) {
-            self::$_all_states = $this->get_all(['order_by' => ['STA_name' => 'ASC'], 'limit' => [0, 99999]]);
-        }
-        return self::$_all_states;
-    }
-
-
-    /**
-     * @param EE_Country[] $countries
-     * @param bool         $flush_cache
-     * @return EE_State[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active_states(array $countries = [], bool $flush_cache = false): array
-    {
-        if (! self::$_active_states || $flush_cache) {
-            $countries            = ! empty($countries) && is_array($countries)
-                ? $countries
-                : EEM_Country::instance()->get_all_active_countries();
-            self::$_active_states = $this->get_all(
-                [
-                    [
-                        'STA_active' => true,
-                        'CNT_ISO'    => ['IN', array_keys($countries)],
-                    ],
-                    'order_by'   => ['STA_name' => 'ASC'],
-                    'limit'      => [0, 99999],
-                    'force_join' => ['Country'],
-                ]
-            );
-        }
-        return self::$_active_states;
-    }
-
-
-    /**
-     *  get_all_states_of_active_countries
-     *
-     * @return EE_State[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_states_of_active_countries(): array
-    {
-        return $this->get_all(
-            [
-                ['Country.CNT_active' => true, 'STA_active' => true],
-                'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     *  get_all_states_of_active_countries
-     *
-     * @param $countries
-     * @return EE_State[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_active_states_for_these_countries($countries): array
-    {
-        if (! $countries) {
-            return [];
-        }
-        return $this->get_all(
-            [
-                ['Country.CNT_ISO' => ['IN', array_keys($countries)], 'STA_active' => true],
-                'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     *  get_all_states_of_active_countries
-     *
-     * @param $countries
-     * @return EE_State[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_states_for_these_countries($countries): array
-    {
-        if (! $countries) {
-            return [];
-        }
-        return $this->get_all(
-            [
-                ['Country.CNT_ISO' => ['IN', array_keys($countries)]],
-                'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
-            ]
-        );
-    }
-
-
-    /**
-     * Gets the state's name by its ID
-     *
-     * @param string $state_ID
-     * @return string
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_state_name_by_ID(string $state_ID): string
-    {
-        if (
-            isset(self::$_all_states[ $state_ID ]) && self::$_all_states[ $state_ID ] instanceof EE_State
-        ) {
-            return self::$_all_states[ $state_ID ]->name();
-        }
-        $names = $this->get_col([['STA_ID' => $state_ID], 'limit' => 1], 'STA_name');
-        return is_array($names) && ! empty($names)
-            ? reset($names)
-            : '';
-    }
+	/**
+	 * @var EEM_State
+	 */
+	protected static $_instance;
+
+	/**
+	 * @var EE_State[]
+	 */
+	private static $_all_states;
+
+	/**
+	 * @var EE_State[]
+	 */
+	private static $_active_states;
+
+
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('State/Province', 'event_espresso');
+		$this->plural_item   = esc_html__('States/Provinces', 'event_espresso');
+
+		$this->_tables = [
+			'State' => new EE_Primary_Table('esp_state', 'STA_ID'),
+		];
+
+		$this->_fields          = [
+			'State' => [
+				'STA_ID'     => new EE_Primary_Key_Int_Field(
+					'STA_ID',
+					esc_html__('State ID', 'event_espresso')
+				),
+				'CNT_ISO'    => new EE_Foreign_Key_String_Field(
+					'CNT_ISO',
+					esc_html__('Country ISO Code', 'event_espresso'),
+					false,
+					null,
+					'Country'
+				),
+				'STA_abbrev' => new EE_Plain_Text_Field(
+					'STA_abbrev',
+					esc_html__('State Abbreviation', 'event_espresso'),
+					false,
+					''
+				),
+				'STA_name'   => new EE_Plain_Text_Field(
+					'STA_name',
+					esc_html__('State Name', 'event_espresso'),
+					false,
+					''
+				),
+				'STA_active' => new EE_Boolean_Field(
+					'STA_active',
+					esc_html__('State Active Flag', 'event_espresso'),
+					false,
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Attendee' => new EE_Has_Many_Relation(),
+			'Country'  => new EE_Belongs_To_Relation(),
+			'Venue'    => new EE_Has_Many_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] = new EE_Restriction_Generator_Public();
+		// @todo: only show STA_active
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * reset_cached_states
+	 *
+	 * @return void
+	 */
+	public function reset_cached_states()
+	{
+		EEM_State::$_active_states = null;
+		EEM_State::$_all_states    = null;
+	}
+
+
+	/**
+	 * _get_states
+	 *
+	 * @return EE_State[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_states(): array
+	{
+		if (self::$_all_states === null) {
+			self::$_all_states = $this->get_all(['order_by' => ['STA_name' => 'ASC'], 'limit' => [0, 99999]]);
+		}
+		return self::$_all_states;
+	}
+
+
+	/**
+	 * @param EE_Country[] $countries
+	 * @param bool         $flush_cache
+	 * @return EE_State[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active_states(array $countries = [], bool $flush_cache = false): array
+	{
+		if (! self::$_active_states || $flush_cache) {
+			$countries            = ! empty($countries) && is_array($countries)
+				? $countries
+				: EEM_Country::instance()->get_all_active_countries();
+			self::$_active_states = $this->get_all(
+				[
+					[
+						'STA_active' => true,
+						'CNT_ISO'    => ['IN', array_keys($countries)],
+					],
+					'order_by'   => ['STA_name' => 'ASC'],
+					'limit'      => [0, 99999],
+					'force_join' => ['Country'],
+				]
+			);
+		}
+		return self::$_active_states;
+	}
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 *
+	 * @return EE_State[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_states_of_active_countries(): array
+	{
+		return $this->get_all(
+			[
+				['Country.CNT_active' => true, 'STA_active' => true],
+				'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 *
+	 * @param $countries
+	 * @return EE_State[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_active_states_for_these_countries($countries): array
+	{
+		if (! $countries) {
+			return [];
+		}
+		return $this->get_all(
+			[
+				['Country.CNT_ISO' => ['IN', array_keys($countries)], 'STA_active' => true],
+				'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 *  get_all_states_of_active_countries
+	 *
+	 * @param $countries
+	 * @return EE_State[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_states_for_these_countries($countries): array
+	{
+		if (! $countries) {
+			return [];
+		}
+		return $this->get_all(
+			[
+				['Country.CNT_ISO' => ['IN', array_keys($countries)]],
+				'order_by' => ['Country.CNT_name' => 'ASC', 'STA_name' => 'ASC'],
+			]
+		);
+	}
+
+
+	/**
+	 * Gets the state's name by its ID
+	 *
+	 * @param string $state_ID
+	 * @return string
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_state_name_by_ID(string $state_ID): string
+	{
+		if (
+			isset(self::$_all_states[ $state_ID ]) && self::$_all_states[ $state_ID ] instanceof EE_State
+		) {
+			return self::$_all_states[ $state_ID ]->name();
+		}
+		$names = $this->get_col([['STA_ID' => $state_ID], 'limit' => 1], 'STA_name');
+		return is_array($names) && ! empty($names)
+			? reset($names)
+			: '';
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -35,7 +35,7 @@ 
             'State' => new EE_Primary_Table('esp_state', 'STA_ID'),
         ];
 
-        $this->_fields          = [
+        $this->_fields = [
             'State' => [
                 'STA_ID'     => new EE_Primary_Key_Int_Field(
                     'STA_ID',
@@ -74,7 +74,7 @@ 
             'Venue'    => new EE_Has_Many_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();
         // @todo: only show STA_active
         parent::__construct($timezone);
     }
@@ -117,7 +117,7 @@ 
      */
     public function get_all_active_states(array $countries = [], bool $flush_cache = false): array
     {
-        if (! self::$_active_states || $flush_cache) {
+        if ( ! self::$_active_states || $flush_cache) {
             $countries            = ! empty($countries) && is_array($countries)
                 ? $countries
                 : EEM_Country::instance()->get_all_active_countries();
@@ -165,7 +165,7 @@ 
      */
     public function get_all_active_states_for_these_countries($countries): array
     {
-        if (! $countries) {
+        if ( ! $countries) {
             return [];
         }
         return $this->get_all(
@@ -187,7 +187,7 @@ 
      */
     public function get_all_states_for_these_countries($countries): array
     {
-        if (! $countries) {
+        if ( ! $countries) {
             return [];
         }
         return $this->get_all(
@@ -210,9 +210,9 @@ 
     public function get_state_name_by_ID(string $state_ID): string
     {
         if (
-            isset(self::$_all_states[ $state_ID ]) && self::$_all_states[ $state_ID ] instanceof EE_State
+            isset(self::$_all_states[$state_ID]) && self::$_all_states[$state_ID] instanceof EE_State
         ) {
-            return self::$_all_states[ $state_ID ]->name();
+            return self::$_all_states[$state_ID]->name();
         }
         $names = $this->get_col([['STA_ID' => $state_ID], 'limit' => 1], 'STA_name');
         return is_array($names) && ! empty($names)

core/db_models/EEM_Post_Meta.model.php

Indentation +49 added lines, -49 removed lines

@@ -18,56 +18,56 @@
 class EEM_Post_Meta extends EEM_Base
 {
 
-    // private instance of the EE_Post_Meta object
-    protected static $_instance;
+	// private instance of the EE_Post_Meta object
+	protected static $_instance;
 
 
 
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Post Meta', 'event_espresso');
-        $this->plural_item = esc_html__('Post Metas', 'event_espresso');
-        $this->_tables = array(
-            'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
-        );
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields = array(
-            'Post_Meta' => array(
-                'meta_id'    => new EE_Primary_Key_Int_Field(
-                    'meta_id',
-                    esc_html__("Meta ID", "event_espresso")
-                ),
-                'post_id'    => new EE_Foreign_Key_Int_Field(
-                    'post_id',
-                    esc_html__("Primary Key of Post", "event_espresso"),
-                    false,
-                    0,
-                    $models_this_can_attach_to
-                ),
-                'meta_key'   => new EE_Plain_Text_Field(
-                    'meta_key',
-                    esc_html__("Meta Key", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'meta_value' => new EE_Maybe_Serialized_Text_Field(
-                    'meta_value',
-                    esc_html__("Meta Value", "event_espresso"),
-                    true
-                ),
-            ),
-        );
-        $this->_model_relations = array();
-        foreach ($models_this_can_attach_to as $model) {
-            $this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
-        }
-        $this->_wp_core_model = true;
-        foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
-            $this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
-                'meta_key',
-                'meta_value'
-            );
-        }
-        parent::__construct($timezone);
-    }
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Post Meta', 'event_espresso');
+		$this->plural_item = esc_html__('Post Metas', 'event_espresso');
+		$this->_tables = array(
+			'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
+		);
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields = array(
+			'Post_Meta' => array(
+				'meta_id'    => new EE_Primary_Key_Int_Field(
+					'meta_id',
+					esc_html__("Meta ID", "event_espresso")
+				),
+				'post_id'    => new EE_Foreign_Key_Int_Field(
+					'post_id',
+					esc_html__("Primary Key of Post", "event_espresso"),
+					false,
+					0,
+					$models_this_can_attach_to
+				),
+				'meta_key'   => new EE_Plain_Text_Field(
+					'meta_key',
+					esc_html__("Meta Key", "event_espresso"),
+					false,
+					''
+				),
+				'meta_value' => new EE_Maybe_Serialized_Text_Field(
+					'meta_value',
+					esc_html__("Meta Value", "event_espresso"),
+					true
+				),
+			),
+		);
+		$this->_model_relations = array();
+		foreach ($models_this_can_attach_to as $model) {
+			$this->_model_relations[ $model ] = new EE_Belongs_To_Relation();
+		}
+		$this->_wp_core_model = true;
+		foreach ($this->cap_contexts_to_cap_action_map() as $cap_context => $action) {
+			$this->_cap_restriction_generators[ $cap_context ] = new EE_Restriction_Generator_Meta(
+				'meta_key',
+				'meta_value'
+			);
+		}
+		parent::__construct($timezone);
+	}
 }

core/db_models/EEM_Event_Question_Group.model.php

Indentation +100 added lines, -100 removed lines

@@ -15,113 +15,113 @@
 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;
+	// private instance of the Event_Question_Group object
+	protected static $_instance;
 
 
-    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(),
-        ];
+	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';
 
-        $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->_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);
 
-        parent::__construct($timezone);
-    }
+		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_Question.model.php

Indentation +575 added lines, -575 removed lines

@@ -10,580 +10,580 @@
 class EEM_Question extends EEM_Soft_Delete_Base
 {
 
-    // constant used to indicate that the question type is CHECKBOX
-    const QST_type_checkbox = 'CHECKBOX';
+	// constant used to indicate that the question type is CHECKBOX
+	const QST_type_checkbox = 'CHECKBOX';
 
-    // constant used to indicate that the question type is COUNTRY
-    const QST_type_country = 'COUNTRY';
-
-    // constant used to indicate that the question type is DATE
-    const QST_type_date = 'DATE';
-
-    // constant used to indicate that the question type is a decimal (float)
-    const QST_type_decimal = 'DECIMAL';
-
-    // constant used to indicate that the question type is DROPDOWN
-    const QST_type_dropdown = 'DROPDOWN';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email = 'EMAIL';
-
-    // constant used to indicate that the question type is an email input
-    const QST_type_email_confirm = 'EMAIL_CONFIRM';
-
-    // constant used to indicate that the question type is a TEXTAREA that allows simple html
-    const QST_type_html_textarea = 'HTML_TEXTAREA';
-
-    // constant used to indicate that the question type is an integer (whole number)
-    const QST_type_int = 'INTEGER';
-
-    // constant used to indicate that the question type is a multi-select
-    const QST_type_multi_select = 'MULTI_SELECT';
-
-    // constant used to indicate that the question type is RADIO_BTN
-    const QST_type_radio = 'RADIO_BTN';
-
-    // constant used to indicate that the question type is STATE
-    const QST_type_state = 'STATE';
-
-    // constant used to indicate that the question type is TEXT
-    const QST_type_text = 'TEXT';
-
-    // constant used to indicate that the question type is TEXTAREA
-    const QST_type_textarea = 'TEXTAREA';
-
-    // constant used to indicate that the question type is a valid URL
-    const QST_type_url = 'URL';
-
-    // constant used to indicate that the question type is a US-formatted phone number
-    const QST_type_us_phone = 'US_PHONE';
-
-    // constant used to indicate that the question type is a YEAR
-    const QST_type_year = 'YEAR';
-
-    /**
-     * lists all the question types which should be allowed. Ideally, this will be extensible.
-     *
-     * @var array $_allowed_question_types
-     */
-    protected $_allowed_question_types = [];
-
-
-    // private instance of the Attendee object
-    protected static $_instance;
-
-    /**
-     * brief descriptions for all the question types
-     *
-     * @var EEM_Question $_instance
-     */
-    protected $_question_descriptions;
-
-    /**
-     * Question types that are interchangeable, even after answers have been provided for them.
-     * Top-level keys are category slugs, next level is an array of question types. If question types
-     * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
-     *
-     * @var array   $_question_type_categories {
-     *      @type string $text
-     *      @type string $single -answer-enum
-     *      @type string $multi -answer-enum
-     * }
-     */
-    protected $_question_type_categories = [];
-
-
-    /**
-     * Question types that should have an admin-defined max input length
-     *
-     * @var array
-     */
-    protected $question_types_with_max_length;
-
-
-    /**
-     * EEM_Question constructor.
-     *
-     * @param string $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(string $timezone = '')
-    {
-        $this->singular_item                  = esc_html__('Question', 'event_espresso');
-        $this->plural_item                    = esc_html__('Questions', 'event_espresso');
-        $this->_allowed_question_types        = apply_filters(
-            'FHEE__EEM_Question__construct__allowed_question_types',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
-                EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
-                EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
-                EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
-                EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
-                EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
-                EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
-                EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
-                EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
-                EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
-                EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
-                EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
-                EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
-                EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
-                EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
-            ]
-        );
-        $this->_question_descriptions         = apply_filters(
-            'FHEE__EEM_Question__construct__question_descriptions',
-            [
-                EEM_Question::QST_type_checkbox      => esc_html__(
-                    'Allows multiple preset options to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_country       => esc_html__(
-                    'A dropdown that lists countries',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_date          => esc_html__(
-                    'A popup calendar that allows date selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_decimal       => esc_html__(
-                    'A text field that allows number values with decimals',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_dropdown      => esc_html__(
-                    'A dropdown that allows a single selection',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email         => esc_html__(
-                    'A text field that must contain a valid Email address',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_email_confirm => esc_html__(
-                    'A text field that must contain a valid Email address and be equal to Email field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_html_textarea => esc_html__(
-                    'A multi line text input field that allows HTML',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_int           => esc_html__(
-                    'A text field that only allows whole numbers (no decimals)',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_multi_select  => esc_html__(
-                    'A dropdown that allows multiple selections',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_radio         => esc_html__(
-                    'Allows a single preset option to be selected',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_state         => esc_html__(
-                    'A dropdown that lists states/provinces',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_text          => esc_html__(
-                    'A single line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_textarea      => esc_html__(
-                    'A multi line text input field',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_url           => esc_html__(
-                    'A text field that must contain a valid URL',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_us_phone      => esc_html__(
-                    'A text field that must contain a valid US phone number',
-                    'event_espresso'
-                ),
-                EEM_Question::QST_type_year          => esc_html__(
-                    'A dropdown that lists the last 100 years',
-                    'event_espresso'
-                ),
-            ]
-        );
-        $this->_question_type_categories      = (array) apply_filters(
-            'FHEE__EEM_Question__construct__question_type_categories',
-            [
-                'text'               => [
-                    EEM_Question::QST_type_date,
-                    EEM_Question::QST_type_decimal,
-                    EEM_Question::QST_type_email,
-                    EEM_Question::QST_type_email_confirm,
-                    EEM_Question::QST_type_html_textarea,
-                    EEM_Question::QST_type_int,
-                    EEM_Question::QST_type_text,
-                    EEM_Question::QST_type_textarea,
-                    EEM_Question::QST_type_url,
-                    EEM_Question::QST_type_us_phone,
-                    EEM_Question::QST_type_year,
-                ],
-                'single-answer-enum' => [
-                    EEM_Question::QST_type_dropdown,
-                    EEM_Question::QST_type_radio,
-                ],
-                'multi-answer-enum'  => [
-                    EEM_Question::QST_type_multi_select,
-                    EEM_Question::QST_type_checkbox,
-                ],
-            ]
-        );
-        $this->question_types_with_max_length = apply_filters(
-            'FHEE__EEM_Question___construct__question_types_with_max_length',
-            [
-                EEM_Question::QST_type_html_textarea,
-                EEM_Question::QST_type_text,
-                EEM_Question::QST_type_textarea,
-            ]
-        );
-
-        $this->_tables          = [
-            'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
-        ];
-        $this->_fields          = [
-            'Question' => [
-                'QST_ID'            => new EE_Primary_Key_Int_Field(
-                    'QST_ID',
-                    esc_html__('Question ID', 'event_espresso')
-                ),
-                'QST_admin_label'   => new EE_Plain_Text_Field(
-                    'QST_admin_label',
-                    esc_html__('Question Label (admin-only)', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_admin_only'    => new EE_Boolean_Field(
-                    'QST_admin_only',
-                    esc_html__('Admin-Only Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_deleted'       => new EE_Trashed_Flag_Field(
-                    'QST_deleted',
-                    esc_html__('Flag Indicating question was deleted', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_display_text'  => new EE_Post_Content_Field(
-                    'QST_display_text',
-                    esc_html__('Question Text', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_max'           => new EE_Infinite_Integer_Field(
-                    'QST_max',
-                    esc_html__('Max Size', 'event_espresso'),
-                    false,
-                    EE_INF
-                ),
-                'QST_order'         => new EE_Integer_Field(
-                    'QST_order',
-                    esc_html__('Question Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'QST_required'      => new EE_Boolean_Field(
-                    'QST_required',
-                    esc_html__('Required Question?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'QST_required_text' => new EE_Simple_HTML_Field(
-                    'QST_required_text',
-                    esc_html__('Text to Display if Not Provided', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'QST_system'        => new EE_Plain_Text_Field(
-                    'QST_system',
-                    esc_html__('Internal string ID for question', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'QST_type'          => new EE_Enum_Text_Field(
-                    'QST_type',
-                    esc_html__('Question Type', 'event_espresso'),
-                    false,
-                    'TEXT',
-                    $this->_allowed_question_types
-                ),
-                'QST_wp_user'       => new EE_WP_User_Field(
-                    'QST_wp_user',
-                    esc_html__('Question Creator ID', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Answer'                  => new EE_Has_Many_Relation(),
-            'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
-            // for QST_order column
-            'Question_Group_Question' => new EE_Has_Many_Relation(),
-            'Question_Option'         => 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();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form(
-            'QST_system'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form(
-                'QST_system'
-        );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form(
-                'QST_system'
-        );
-
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Returns the list of allowed question types, which are normally:
-     * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
-     *
-     * @return string[]
-     */
-    public function allowed_question_types(): array
-    {
-        return $this->_allowed_question_types;
-    }
-
-
-    /**
-     * Gets all the question types in the same category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types(
-     * @return string[] like EEM_Question::allowed_question_types()
-     */
-    public function question_types_in_same_category(string $question_type): array
-    {
-        $question_types = [$question_type];
-        foreach ($this->_question_type_categories as $question_types_in_category) {
-            if (in_array($question_type, $question_types_in_category)) {
-                $question_types = $question_types_in_category;
-                break;
-            }
-        }
-
-        return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
-    }
-
-
-    /**
-     * Determines if the given question type is in the given question type category
-     *
-     * @param string $question_type one of EEM_Question::allowed_question_types()
-     * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
-     * @return boolean
-     */
-    public function question_type_is_in_category(string $question_type, string $category): bool
-    {
-        if (! isset($this->_question_type_categories[ $category ])) {
-            return false;
-        }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
-    }
-
-
-    /**
-     * Returns all the question types in the given category
-     *
-     * @param string $category
-     * @return array|mixed
-     */
-    public function question_types_in_category(string $category): array
-    {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
-        }
-        return [];
-    }
-
-
-    /**
-     * Returns all the question types that should have question options
-     *
-     * @return array
-     */
-    public function question_types_with_options(): array
-    {
-        return array_merge(
-            $this->question_types_in_category('single-answer-enum'),
-            $this->question_types_in_category('multi-answer-enum')
-        );
-    }
-
-
-    /**
-     * Returns the question type categories 2d array
-     *
-     * @return array see EEM_Question::_question_type_categories
-     */
-    public function question_type_categories(): array
-    {
-        return $this->_question_type_categories;
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that can be allowed in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        $question_system_ids = [];
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_lname,
-                    EEM_Attendee::system_question_email,
-                    EEM_Attendee::system_question_email_confirm,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-            case EEM_Question_Group::system_address:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_address,
-                    EEM_Attendee::system_question_address2,
-                    EEM_Attendee::system_question_city,
-                    EEM_Attendee::system_question_state,
-                    EEM_Attendee::system_question_country,
-                    EEM_Attendee::system_question_zip,
-                    EEM_Attendee::system_question_phone,
-                ];
-                break;
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Returns an array of all the QST_system values that are required in the system question group
-     * identified by $system_question_group_id
-     *
-     * @param string $system_question_group_id QSG_system
-     * @return array of system question names (QST_system)
-     */
-    public function required_system_questions_in_system_question_group(string $system_question_group_id): array
-    {
-        switch ($system_question_group_id) {
-            case EEM_Question_Group::system_personal:
-                $question_system_ids = [
-                    EEM_Attendee::system_question_fname,
-                    EEM_Attendee::system_question_email,
-                ];
-                break;
-            default:
-                $question_system_ids = [];
-        }
-        return apply_filters(
-            'FHEE__EEM_Question__system_questions_required_in_system_question_group',
-            $question_system_ids,
-            $system_question_group_id
-        );
-    }
-
-
-    /**
-     * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
-     * which system question QST_ID corresponds to the QST_system 'city', use
-     * EEM_Question::instance()->get_Question_ID_from_system_string('city');
-     *
-     * @param $QST_system
-     * @return int of QST_ID for the question that corresponds to that QST_system
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_Question_ID_from_system_string($QST_system): int
-    {
-        return $this->get_var([['QST_system' => $QST_system]]);
-    }
-
-
-    /**
-     * searches the db for the question with the latest question order and returns that value.
-     *
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_latest_question_order(): int
-    {
-        $columns_to_select = [
-            'max_order' => ["MAX(QST_order)", "%d"],
-        ];
-        $max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
-        return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
-    }
-
-
-    /**
-     * Returns an array where keys are system question QST_system values,
-     * and values are the highest question max the admin can set on the question
-     * (aka the "max max"; eg, a site admin can change the zip question to have a max
-     * of 5, but no larger than 12)
-     *
-     * @return array
-     */
-    public function system_question_maxes(): array
-    {
-        return [
-            'fname'         => 45,
-            'lname'         => 45,
-            'address'       => 255,
-            'address2'      => 255,
-            'city'          => 45,
-            'zip'           => 12,
-            'email'         => 255,
-            'email_confirm' => 255,
-            'phone'         => 45,
-        ];
-    }
-
-
-    /**
-     * Given a QST_system value, gets the question's largest allowable max input.
-     *
-     * @param string $system_question_value
-     * @return int|float
-     * @see Registration_Form_Admin_Page::system_question_maxes()
-     */
-    public function absolute_max_for_system_question(string $system_question_value)
-    {
-        $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
-    }
-
-
-    /**
-     * @return array
-     */
-    public function question_descriptions(): array
-    {
-        return $this->_question_descriptions;
-    }
-
-
-    /**
-     * Returns all the question types that should have an admin-defined max input length
-     *
-     * @return array
-     */
-    public function questionTypesWithMaxLength(): array
-    {
-        return (array) $this->question_types_with_max_length;
-    }
+	// constant used to indicate that the question type is COUNTRY
+	const QST_type_country = 'COUNTRY';
+
+	// constant used to indicate that the question type is DATE
+	const QST_type_date = 'DATE';
+
+	// constant used to indicate that the question type is a decimal (float)
+	const QST_type_decimal = 'DECIMAL';
+
+	// constant used to indicate that the question type is DROPDOWN
+	const QST_type_dropdown = 'DROPDOWN';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email = 'EMAIL';
+
+	// constant used to indicate that the question type is an email input
+	const QST_type_email_confirm = 'EMAIL_CONFIRM';
+
+	// constant used to indicate that the question type is a TEXTAREA that allows simple html
+	const QST_type_html_textarea = 'HTML_TEXTAREA';
+
+	// constant used to indicate that the question type is an integer (whole number)
+	const QST_type_int = 'INTEGER';
+
+	// constant used to indicate that the question type is a multi-select
+	const QST_type_multi_select = 'MULTI_SELECT';
+
+	// constant used to indicate that the question type is RADIO_BTN
+	const QST_type_radio = 'RADIO_BTN';
+
+	// constant used to indicate that the question type is STATE
+	const QST_type_state = 'STATE';
+
+	// constant used to indicate that the question type is TEXT
+	const QST_type_text = 'TEXT';
+
+	// constant used to indicate that the question type is TEXTAREA
+	const QST_type_textarea = 'TEXTAREA';
+
+	// constant used to indicate that the question type is a valid URL
+	const QST_type_url = 'URL';
+
+	// constant used to indicate that the question type is a US-formatted phone number
+	const QST_type_us_phone = 'US_PHONE';
+
+	// constant used to indicate that the question type is a YEAR
+	const QST_type_year = 'YEAR';
+
+	/**
+	 * lists all the question types which should be allowed. Ideally, this will be extensible.
+	 *
+	 * @var array $_allowed_question_types
+	 */
+	protected $_allowed_question_types = [];
+
+
+	// private instance of the Attendee object
+	protected static $_instance;
+
+	/**
+	 * brief descriptions for all the question types
+	 *
+	 * @var EEM_Question $_instance
+	 */
+	protected $_question_descriptions;
+
+	/**
+	 * Question types that are interchangeable, even after answers have been provided for them.
+	 * Top-level keys are category slugs, next level is an array of question types. If question types
+	 * aren't in this array, it is assumed they AREN'T interchangeable with any other question types.
+	 *
+	 * @var array   $_question_type_categories {
+	 *      @type string $text
+	 *      @type string $single -answer-enum
+	 *      @type string $multi -answer-enum
+	 * }
+	 */
+	protected $_question_type_categories = [];
+
+
+	/**
+	 * Question types that should have an admin-defined max input length
+	 *
+	 * @var array
+	 */
+	protected $question_types_with_max_length;
+
+
+	/**
+	 * EEM_Question constructor.
+	 *
+	 * @param string $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(string $timezone = '')
+	{
+		$this->singular_item                  = esc_html__('Question', 'event_espresso');
+		$this->plural_item                    = esc_html__('Questions', 'event_espresso');
+		$this->_allowed_question_types        = apply_filters(
+			'FHEE__EEM_Question__construct__allowed_question_types',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__('Checkboxes', 'event_espresso'),
+				EEM_Question::QST_type_country       => esc_html__('Country Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_date          => esc_html__('Date Picker', 'event_espresso'),
+				EEM_Question::QST_type_decimal       => esc_html__('Number', 'event_espresso'),
+				EEM_Question::QST_type_dropdown      => esc_html__('Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_email         => esc_html__('Email', 'event_espresso'),
+				EEM_Question::QST_type_email_confirm => esc_html__('Confirm Email', 'event_espresso'),
+				EEM_Question::QST_type_html_textarea => esc_html__('HTML Textarea', 'event_espresso'),
+				EEM_Question::QST_type_int           => esc_html__('Whole Number', 'event_espresso'),
+				EEM_Question::QST_type_multi_select  => esc_html__('Multi Select', 'event_espresso'),
+				EEM_Question::QST_type_radio         => esc_html__('Radio Buttons', 'event_espresso'),
+				EEM_Question::QST_type_state         => esc_html__('State/Province Dropdown', 'event_espresso'),
+				EEM_Question::QST_type_text          => esc_html__('Text', 'event_espresso'),
+				EEM_Question::QST_type_textarea      => esc_html__('Textarea', 'event_espresso'),
+				EEM_Question::QST_type_url           => esc_html__('URL', 'event_espresso'),
+				EEM_Question::QST_type_us_phone      => esc_html__('USA - Format Phone', 'event_espresso'),
+				EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
+			]
+		);
+		$this->_question_descriptions         = apply_filters(
+			'FHEE__EEM_Question__construct__question_descriptions',
+			[
+				EEM_Question::QST_type_checkbox      => esc_html__(
+					'Allows multiple preset options to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_country       => esc_html__(
+					'A dropdown that lists countries',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_date          => esc_html__(
+					'A popup calendar that allows date selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_decimal       => esc_html__(
+					'A text field that allows number values with decimals',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_dropdown      => esc_html__(
+					'A dropdown that allows a single selection',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email         => esc_html__(
+					'A text field that must contain a valid Email address',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_email_confirm => esc_html__(
+					'A text field that must contain a valid Email address and be equal to Email field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_html_textarea => esc_html__(
+					'A multi line text input field that allows HTML',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_int           => esc_html__(
+					'A text field that only allows whole numbers (no decimals)',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_multi_select  => esc_html__(
+					'A dropdown that allows multiple selections',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_radio         => esc_html__(
+					'Allows a single preset option to be selected',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_state         => esc_html__(
+					'A dropdown that lists states/provinces',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_text          => esc_html__(
+					'A single line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_textarea      => esc_html__(
+					'A multi line text input field',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_url           => esc_html__(
+					'A text field that must contain a valid URL',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_us_phone      => esc_html__(
+					'A text field that must contain a valid US phone number',
+					'event_espresso'
+				),
+				EEM_Question::QST_type_year          => esc_html__(
+					'A dropdown that lists the last 100 years',
+					'event_espresso'
+				),
+			]
+		);
+		$this->_question_type_categories      = (array) apply_filters(
+			'FHEE__EEM_Question__construct__question_type_categories',
+			[
+				'text'               => [
+					EEM_Question::QST_type_date,
+					EEM_Question::QST_type_decimal,
+					EEM_Question::QST_type_email,
+					EEM_Question::QST_type_email_confirm,
+					EEM_Question::QST_type_html_textarea,
+					EEM_Question::QST_type_int,
+					EEM_Question::QST_type_text,
+					EEM_Question::QST_type_textarea,
+					EEM_Question::QST_type_url,
+					EEM_Question::QST_type_us_phone,
+					EEM_Question::QST_type_year,
+				],
+				'single-answer-enum' => [
+					EEM_Question::QST_type_dropdown,
+					EEM_Question::QST_type_radio,
+				],
+				'multi-answer-enum'  => [
+					EEM_Question::QST_type_multi_select,
+					EEM_Question::QST_type_checkbox,
+				],
+			]
+		);
+		$this->question_types_with_max_length = apply_filters(
+			'FHEE__EEM_Question___construct__question_types_with_max_length',
+			[
+				EEM_Question::QST_type_html_textarea,
+				EEM_Question::QST_type_text,
+				EEM_Question::QST_type_textarea,
+			]
+		);
+
+		$this->_tables          = [
+			'Question' => new EE_Primary_Table('esp_question', 'QST_ID'),
+		];
+		$this->_fields          = [
+			'Question' => [
+				'QST_ID'            => new EE_Primary_Key_Int_Field(
+					'QST_ID',
+					esc_html__('Question ID', 'event_espresso')
+				),
+				'QST_admin_label'   => new EE_Plain_Text_Field(
+					'QST_admin_label',
+					esc_html__('Question Label (admin-only)', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_admin_only'    => new EE_Boolean_Field(
+					'QST_admin_only',
+					esc_html__('Admin-Only Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_deleted'       => new EE_Trashed_Flag_Field(
+					'QST_deleted',
+					esc_html__('Flag Indicating question was deleted', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_display_text'  => new EE_Post_Content_Field(
+					'QST_display_text',
+					esc_html__('Question Text', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_max'           => new EE_Infinite_Integer_Field(
+					'QST_max',
+					esc_html__('Max Size', 'event_espresso'),
+					false,
+					EE_INF
+				),
+				'QST_order'         => new EE_Integer_Field(
+					'QST_order',
+					esc_html__('Question Order', 'event_espresso'),
+					false,
+					0
+				),
+				'QST_required'      => new EE_Boolean_Field(
+					'QST_required',
+					esc_html__('Required Question?', 'event_espresso'),
+					false,
+					false
+				),
+				'QST_required_text' => new EE_Simple_HTML_Field(
+					'QST_required_text',
+					esc_html__('Text to Display if Not Provided', 'event_espresso'),
+					true,
+					''
+				),
+				'QST_system'        => new EE_Plain_Text_Field(
+					'QST_system',
+					esc_html__('Internal string ID for question', 'event_espresso'),
+					false,
+					''
+				),
+				'QST_type'          => new EE_Enum_Text_Field(
+					'QST_type',
+					esc_html__('Question Type', 'event_espresso'),
+					false,
+					'TEXT',
+					$this->_allowed_question_types
+				),
+				'QST_wp_user'       => new EE_WP_User_Field(
+					'QST_wp_user',
+					esc_html__('Question Creator ID', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Answer'                  => new EE_Has_Many_Relation(),
+			'Question_Group'          => new EE_HABTM_Relation('Question_Group_Question'),
+			// for QST_order column
+			'Question_Group_Question' => new EE_Has_Many_Relation(),
+			'Question_Option'         => 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();
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] = new EE_Restriction_Generator_Reg_Form(
+			'QST_system'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form(
+				'QST_system'
+		);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form(
+				'QST_system'
+		);
+
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Returns the list of allowed question types, which are normally:
+	 * 'TEXT','TEXTAREA','RADIO_BTN','DROPDOWN','CHECKBOX','DATE' but they can be extended
+	 *
+	 * @return string[]
+	 */
+	public function allowed_question_types(): array
+	{
+		return $this->_allowed_question_types;
+	}
+
+
+	/**
+	 * Gets all the question types in the same category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types(
+	 * @return string[] like EEM_Question::allowed_question_types()
+	 */
+	public function question_types_in_same_category(string $question_type): array
+	{
+		$question_types = [$question_type];
+		foreach ($this->_question_type_categories as $question_types_in_category) {
+			if (in_array($question_type, $question_types_in_category)) {
+				$question_types = $question_types_in_category;
+				break;
+			}
+		}
+
+		return array_intersect_key($this->allowed_question_types(), array_flip($question_types));
+	}
+
+
+	/**
+	 * Determines if the given question type is in the given question type category
+	 *
+	 * @param string $question_type one of EEM_Question::allowed_question_types()
+	 * @param string $category      one of the top-level keys of EEM_Question::question_type_categories()
+	 * @return boolean
+	 */
+	public function question_type_is_in_category(string $question_type, string $category): bool
+	{
+		if (! isset($this->_question_type_categories[ $category ])) {
+			return false;
+		}
+		return in_array($question_type, $this->_question_type_categories[ $category ]);
+	}
+
+
+	/**
+	 * Returns all the question types in the given category
+	 *
+	 * @param string $category
+	 * @return array|mixed
+	 */
+	public function question_types_in_category(string $category): array
+	{
+		if (isset($this->_question_type_categories[ $category ])) {
+			return $this->_question_type_categories[ $category ];
+		}
+		return [];
+	}
+
+
+	/**
+	 * Returns all the question types that should have question options
+	 *
+	 * @return array
+	 */
+	public function question_types_with_options(): array
+	{
+		return array_merge(
+			$this->question_types_in_category('single-answer-enum'),
+			$this->question_types_in_category('multi-answer-enum')
+		);
+	}
+
+
+	/**
+	 * Returns the question type categories 2d array
+	 *
+	 * @return array see EEM_Question::_question_type_categories
+	 */
+	public function question_type_categories(): array
+	{
+		return $this->_question_type_categories;
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that can be allowed in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function allowed_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		$question_system_ids = [];
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_lname,
+					EEM_Attendee::system_question_email,
+					EEM_Attendee::system_question_email_confirm,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+			case EEM_Question_Group::system_address:
+				$question_system_ids = [
+					EEM_Attendee::system_question_address,
+					EEM_Attendee::system_question_address2,
+					EEM_Attendee::system_question_city,
+					EEM_Attendee::system_question_state,
+					EEM_Attendee::system_question_country,
+					EEM_Attendee::system_question_zip,
+					EEM_Attendee::system_question_phone,
+				];
+				break;
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_allowed_in_system_question_group__return',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Returns an array of all the QST_system values that are required in the system question group
+	 * identified by $system_question_group_id
+	 *
+	 * @param string $system_question_group_id QSG_system
+	 * @return array of system question names (QST_system)
+	 */
+	public function required_system_questions_in_system_question_group(string $system_question_group_id): array
+	{
+		switch ($system_question_group_id) {
+			case EEM_Question_Group::system_personal:
+				$question_system_ids = [
+					EEM_Attendee::system_question_fname,
+					EEM_Attendee::system_question_email,
+				];
+				break;
+			default:
+				$question_system_ids = [];
+		}
+		return apply_filters(
+			'FHEE__EEM_Question__system_questions_required_in_system_question_group',
+			$question_system_ids,
+			$system_question_group_id
+		);
+	}
+
+
+	/**
+	 * Gets an array for converting between QST_system and QST_IDs for system questions. Eg, if you want to know
+	 * which system question QST_ID corresponds to the QST_system 'city', use
+	 * EEM_Question::instance()->get_Question_ID_from_system_string('city');
+	 *
+	 * @param $QST_system
+	 * @return int of QST_ID for the question that corresponds to that QST_system
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_Question_ID_from_system_string($QST_system): int
+	{
+		return $this->get_var([['QST_system' => $QST_system]]);
+	}
+
+
+	/**
+	 * searches the db for the question with the latest question order and returns that value.
+	 *
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_latest_question_order(): int
+	{
+		$columns_to_select = [
+			'max_order' => ["MAX(QST_order)", "%d"],
+		];
+		$max               = $this->_get_all_wpdb_results([], ARRAY_A, $columns_to_select);
+		return isset($max[0], $max[0]['max_order']) ? $max[0]['max_order'] : 0;
+	}
+
+
+	/**
+	 * Returns an array where keys are system question QST_system values,
+	 * and values are the highest question max the admin can set on the question
+	 * (aka the "max max"; eg, a site admin can change the zip question to have a max
+	 * of 5, but no larger than 12)
+	 *
+	 * @return array
+	 */
+	public function system_question_maxes(): array
+	{
+		return [
+			'fname'         => 45,
+			'lname'         => 45,
+			'address'       => 255,
+			'address2'      => 255,
+			'city'          => 45,
+			'zip'           => 12,
+			'email'         => 255,
+			'email_confirm' => 255,
+			'phone'         => 45,
+		];
+	}
+
+
+	/**
+	 * Given a QST_system value, gets the question's largest allowable max input.
+	 *
+	 * @param string $system_question_value
+	 * @return int|float
+	 * @see Registration_Form_Admin_Page::system_question_maxes()
+	 */
+	public function absolute_max_for_system_question(string $system_question_value)
+	{
+		$maxes = $this->system_question_maxes();
+		return $maxes[ $system_question_value ] ?? EE_INF;
+	}
+
+
+	/**
+	 * @return array
+	 */
+	public function question_descriptions(): array
+	{
+		return $this->_question_descriptions;
+	}
+
+
+	/**
+	 * Returns all the question types that should have an admin-defined max input length
+	 *
+	 * @return array
+	 */
+	public function questionTypesWithMaxLength(): array
+	{
+		return (array) $this->question_types_with_max_length;
+	}
 }

Spacing +11 added lines, -11 removed lines

@@ -133,7 +133,7 @@ 
                 EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
             ]
         );
-        $this->_question_descriptions         = apply_filters(
+        $this->_question_descriptions = apply_filters(
             'FHEE__EEM_Question__construct__question_descriptions',
             [
                 EEM_Question::QST_type_checkbox      => esc_html__(
@@ -206,7 +206,7 @@ 
                 ),
             ]
         );
-        $this->_question_type_categories      = (array) apply_filters(
+        $this->_question_type_categories = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_type_categories',
             [
                 'text'               => [
@@ -327,14 +327,14 @@ 
             '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_admin ] = new EE_Restriction_Generator_Reg_Form(
+        $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(
             'QST_system'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ] = new EE_Restriction_Generator_Reg_Form(
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] = new EE_Restriction_Generator_Reg_Form(
                 'QST_system'
         );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ] = new EE_Restriction_Generator_Reg_Form(
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] = new EE_Restriction_Generator_Reg_Form(
                 'QST_system'
         );
 
@@ -383,10 +383,10 @@ 
      */
     public function question_type_is_in_category(string $question_type, string $category): bool
     {
-        if (! isset($this->_question_type_categories[ $category ])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
+        return in_array($question_type, $this->_question_type_categories[$category]);
     }
 
 
@@ -398,8 +398,8 @@ 
      */
     public function question_types_in_category(string $category): array
     {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
+        if (isset($this->_question_type_categories[$category])) {
+            return $this->_question_type_categories[$category];
         }
         return [];
     }
@@ -564,7 +564,7 @@ 
     public function absolute_max_for_system_question(string $system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
+        return $maxes[$system_question_value] ?? EE_INF;
     }
 
 

core/db_models/EEM_Currency_Payment_Method.model.php

Indentation +48 added lines, -48 removed lines

@@ -9,54 +9,54 @@
  */
 class EEM_Currency_Payment_Method extends EEM_Base
 {
-    /**
-     * @var EEM_Currency_Payment_Method
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Currency_Payment_Method
+	 */
+	protected static $_instance;
 
 
-    /**
-     * EEM_Currency_Payment_Method constructor.
-     *
-     * @param string $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__('Payment 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);
-    }
+	/**
+	 * EEM_Currency_Payment_Method constructor.
+	 *
+	 * @param string $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__('Payment 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);
+	}
 }

Spacing +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
             '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->_cap_restriction_generators[EEM_Base::caps_read] = new EE_Restriction_Generator_Public();
         $this->_caps_slug                                         = 'payment_methods';
         parent::__construct($timezone);
     }