eventespresso / event-espresso-core

core/db_models/EEM_Status.model.php

Indentation +293 added lines, -293 removed lines

@@ -10,308 +10,308 @@
  */
 class EEM_Status extends EEM_Base
 {
-    protected static ?EEM_Status $_instance = null;
+	protected static ?EEM_Status $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Status', 'event_espresso');
-        $this->plural_item      = esc_html__('Stati', 'event_espresso');
-        $this->_tables          = [
-            'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
-        ];
-        $this->_fields          = [
-            'StatusTable' => [
-                'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
-                'STS_code'     => new EE_Plain_Text_Field(
-                    'STS_code', esc_html__('Status Code', 'event_espresso'), false, ''
-                ),
-                'STS_type'     => new EE_Enum_Text_Field(
-                    'STS_type',
-                    esc_html__("Type", "event_espresso"),
-                    false,
-                    'event',
-                    [
-                        'event'        => esc_html__("Event", "event_espresso"),// deprecated
-                        'registration' => esc_html__("Registration", "event_espresso"),
-                        'transaction'  => esc_html__("Transaction", "event_espresso"),
-                        'payment'      => esc_html__("Payment", "event_espresso"),
-                        'email'        => esc_html__("Email", "event_espresso"),
-                        'message'      => esc_html__("Message", "event_espresso"),
-                    ]
-                ),
-                'STS_can_edit' => new EE_Boolean_Field(
-                    'STS_can_edit',
-                    esc_html__('Editable?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'STS_desc'     => new EE_Simple_HTML_Field(
-                    'STS_desc',
-                    esc_html__("Description", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
-            ],
-        ];
-        $this->_model_relations = [
-            'Registration' => new EE_Has_Many_Relation(),
-            'Transaction'  => new EE_Has_Many_Relation(),
-            'Payment'      => 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();
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Status', 'event_espresso');
+		$this->plural_item      = esc_html__('Stati', 'event_espresso');
+		$this->_tables          = [
+			'StatusTable' => new EE_Primary_Table('esp_status', 'STS_ID'),
+		];
+		$this->_fields          = [
+			'StatusTable' => [
+				'STS_ID'       => new EE_Primary_Key_String_Field('STS_ID', esc_html__('Status ID', 'event_espresso')),
+				'STS_code'     => new EE_Plain_Text_Field(
+					'STS_code', esc_html__('Status Code', 'event_espresso'), false, ''
+				),
+				'STS_type'     => new EE_Enum_Text_Field(
+					'STS_type',
+					esc_html__("Type", "event_espresso"),
+					false,
+					'event',
+					[
+						'event'        => esc_html__("Event", "event_espresso"),// deprecated
+						'registration' => esc_html__("Registration", "event_espresso"),
+						'transaction'  => esc_html__("Transaction", "event_espresso"),
+						'payment'      => esc_html__("Payment", "event_espresso"),
+						'email'        => esc_html__("Email", "event_espresso"),
+						'message'      => esc_html__("Message", "event_espresso"),
+					]
+				),
+				'STS_can_edit' => new EE_Boolean_Field(
+					'STS_can_edit',
+					esc_html__('Editable?', 'event_espresso'),
+					false,
+					false
+				),
+				'STS_desc'     => new EE_Simple_HTML_Field(
+					'STS_desc',
+					esc_html__("Description", "event_espresso"),
+					false,
+					''
+				),
+				'STS_open'     => new EE_Boolean_Field('STS_open', esc_html__("Open?", "event_espresso"), false, false),
+			],
+		];
+		$this->_model_relations = [
+			'Registration' => new EE_Has_Many_Relation(),
+			'Transaction'  => new EE_Has_Many_Relation(),
+			'Payment'      => 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();
 
-        parent::__construct($timezone);
-    }
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * This method provides the localized singular or plural string for a given status id
-     *
-     * @param array   $statuses  This should be an array of statuses in the format array( $status_id, $status_code ).
-     *                           That way if there isn't a translation in the index we'll return the default code.
-     * @param boolean $plural    Whether to return plural string or not. Note, nearly all of the plural strings are the
-     *                           same as the singular (in English), however, this may NOT be the case with other
-     *                           languages
-     * @param string  $schema    This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
-     *                           the status string returned ( UPPER, lower, Sentence)
-     * @return array             an array of translated strings for the incoming status id.
-     * @throws EE_Error
-     */
-    public function localized_status($statuses, $plural = false, $schema = 'upper')
-    {
-        // note these are all in lower case because ucwords() on upper case will NOT convert.
-        $translation_array = [
-            EEM_Registration::status_id_pending_payment => [
-                esc_html__('pending payment', 'event_espresso'), // singular
-                esc_html__('pending payments', 'event_espresso'), // plural
-            ],
-            EEM_Registration::status_id_approved        => [
-                esc_html__('approved', 'event_espresso'), // singular
-                esc_html__('approved', 'event_espresso'), // plural
-            ],
-            EEM_Registration::status_id_not_approved    => [
-                esc_html__('not approved', 'event_espresso'),
-                esc_html__('not approved', 'event_espresso'),
-            ],
-            EEM_Registration::status_id_cancelled       => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EEM_Registration::status_id_incomplete      => [
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ],
-            EEM_Registration::status_id_declined        => [
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ],
-            EEM_Registration::status_id_wait_list       => [
-                esc_html__('wait list', 'event_espresso'),
-                esc_html__('wait list', 'event_espresso'),
-            ],
-            EEM_Transaction::overpaid_status_code       => [
-                esc_html__('overpaid', 'event_espresso'),
-                esc_html__('overpaid', 'event_espresso'),
-            ],
-            EEM_Transaction::complete_status_code       => [
-                esc_html__('complete', 'event_espresso'),
-                esc_html__('complete', 'event_espresso'),
-            ],
-            EEM_Transaction::incomplete_status_code     => [
-                esc_html__('incomplete', 'event_espresso'),
-                esc_html__('incomplete', 'event_espresso'),
-            ],
-            EEM_Transaction::failed_status_code         => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            EEM_Transaction::abandoned_status_code      => [
-                esc_html__('abandoned', 'event_espresso'),
-                esc_html__('abandoned', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_approved             => [
-                esc_html__('accepted', 'event_espresso'),
-                esc_html__('accepted', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_pending              => [
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_cancelled            => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_declined             => [
-                esc_html__('declined', 'event_espresso'),
-                esc_html__('declined', 'event_espresso'),
-            ],
-            EEM_Payment::status_id_failed               => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            // following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
-            EEM_Event::sold_out                         => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EEM_Event::postponed                        => [
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('Postponed', 'event_espresso'),
-            ],
-            EEM_Event::cancelled                        => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EE_Ticket::archived                         => [
-                esc_html__('archived', 'event_espresso'),
-                esc_html__('archived', 'event_espresso'),
-            ],
-            EE_Ticket::expired                          => [
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ],
-            EE_Ticket::sold_out                         => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EE_Ticket::pending                          => [
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ],
-            EE_Ticket::onsale                           => [
-                esc_html__('on sale', 'event_espresso'),
-                esc_html__('on sale', 'event_espresso'),
-            ],
-            EE_Datetime::cancelled                      => [
-                esc_html__('cancelled', 'event_espresso'),
-                esc_html__('cancelled', 'event_espresso'),
-            ],
-            EE_Datetime::sold_out                       => [
-                esc_html__('sold out', 'event_espresso'),
-                esc_html__('sold out', 'event_espresso'),
-            ],
-            EE_Datetime::expired                        => [
-                esc_html__('expired', 'event_espresso'),
-                esc_html__('expired', 'event_espresso'),
-            ],
-            EE_Datetime::inactive                       => [
-                esc_html__('inactive', 'event_espresso'),
-                esc_html__('inactive', 'event_espresso'),
-            ],
-            EE_Datetime::upcoming                       => [
-                esc_html__('upcoming', 'event_espresso'),
-                esc_html__('upcoming', 'event_espresso'),
-            ],
-            EE_Datetime::active                         => [
-                esc_html__('active', 'event_espresso'),
-                esc_html__('active', 'event_espresso'),
-            ],
-            EE_Datetime::postponed                      => [
-                esc_html__('postponed', 'event_espresso'),
-                esc_html__('postponed', 'event_espresso'),
-            ],
-            // messages related
-            EEM_Message::status_sent                    => [
-                esc_html__('sent', 'event_espresso'),
-                esc_html__('sent', 'event_espresso'),
-            ],
-            EEM_Message::status_idle                    => [
-                esc_html__('queued for sending', 'event_espresso'),
-                esc_html__('queued for sending', 'event_espresso'),
-            ],
-            EEM_Message::status_failed                  => [
-                esc_html__('failed', 'event_espresso'),
-                esc_html__('failed', 'event_espresso'),
-            ],
-            EEM_Message::status_debug_only              => [
-                esc_html__('debug only', 'event_espresso'),
-                esc_html__('debug only', 'event_espresso'),
-            ],
-            EEM_Message::status_messenger_executing     => [
-                esc_html__('messenger is executing', 'event_espresso'),
-                esc_html__('messenger is executing', 'event_espresso'),
-            ],
-            EEM_Message::status_resend                  => [
-                esc_html__('queued for resending', 'event_espresso'),
-                esc_html__('queued for resending', 'event_espresso'),
-            ],
-            EEM_Message::status_incomplete              => [
-                esc_html__('queued for generating', 'event_espresso'),
-                esc_html__('queued for generating', 'event_espresso'),
-            ],
-            EEM_Message::status_retry                   => [
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-                esc_html__('failed sending, can be retried', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_publish           => [
-                esc_html__('published', 'event_espresso'),
-                esc_html__('published', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_future            => [
-                esc_html__('scheduled', 'event_espresso'),
-                esc_html__('scheduled', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_draft             => [
-                esc_html__('draft', 'event_espresso'),
-                esc_html__('draft', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_pending           => [
-                esc_html__('pending', 'event_espresso'),
-                esc_html__('pending', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_private           => [
-                esc_html__('private', 'event_espresso'),
-                esc_html__('private', 'event_espresso'),
-            ],
-            EEM_CPT_Base::post_status_trashed           => [
-                esc_html__('trashed', 'event_espresso'),
-                esc_html__('trashed', 'event_espresso'),
-            ],
-        ];
+	/**
+	 * This method provides the localized singular or plural string for a given status id
+	 *
+	 * @param array   $statuses  This should be an array of statuses in the format array( $status_id, $status_code ).
+	 *                           That way if there isn't a translation in the index we'll return the default code.
+	 * @param boolean $plural    Whether to return plural string or not. Note, nearly all of the plural strings are the
+	 *                           same as the singular (in English), however, this may NOT be the case with other
+	 *                           languages
+	 * @param string  $schema    This can be either 'upper', 'lower', or 'sentence'.  Basically indicates how we want
+	 *                           the status string returned ( UPPER, lower, Sentence)
+	 * @return array             an array of translated strings for the incoming status id.
+	 * @throws EE_Error
+	 */
+	public function localized_status($statuses, $plural = false, $schema = 'upper')
+	{
+		// note these are all in lower case because ucwords() on upper case will NOT convert.
+		$translation_array = [
+			EEM_Registration::status_id_pending_payment => [
+				esc_html__('pending payment', 'event_espresso'), // singular
+				esc_html__('pending payments', 'event_espresso'), // plural
+			],
+			EEM_Registration::status_id_approved        => [
+				esc_html__('approved', 'event_espresso'), // singular
+				esc_html__('approved', 'event_espresso'), // plural
+			],
+			EEM_Registration::status_id_not_approved    => [
+				esc_html__('not approved', 'event_espresso'),
+				esc_html__('not approved', 'event_espresso'),
+			],
+			EEM_Registration::status_id_cancelled       => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EEM_Registration::status_id_incomplete      => [
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			],
+			EEM_Registration::status_id_declined        => [
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			],
+			EEM_Registration::status_id_wait_list       => [
+				esc_html__('wait list', 'event_espresso'),
+				esc_html__('wait list', 'event_espresso'),
+			],
+			EEM_Transaction::overpaid_status_code       => [
+				esc_html__('overpaid', 'event_espresso'),
+				esc_html__('overpaid', 'event_espresso'),
+			],
+			EEM_Transaction::complete_status_code       => [
+				esc_html__('complete', 'event_espresso'),
+				esc_html__('complete', 'event_espresso'),
+			],
+			EEM_Transaction::incomplete_status_code     => [
+				esc_html__('incomplete', 'event_espresso'),
+				esc_html__('incomplete', 'event_espresso'),
+			],
+			EEM_Transaction::failed_status_code         => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			EEM_Transaction::abandoned_status_code      => [
+				esc_html__('abandoned', 'event_espresso'),
+				esc_html__('abandoned', 'event_espresso'),
+			],
+			EEM_Payment::status_id_approved             => [
+				esc_html__('accepted', 'event_espresso'),
+				esc_html__('accepted', 'event_espresso'),
+			],
+			EEM_Payment::status_id_pending              => [
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			],
+			EEM_Payment::status_id_cancelled            => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EEM_Payment::status_id_declined             => [
+				esc_html__('declined', 'event_espresso'),
+				esc_html__('declined', 'event_espresso'),
+			],
+			EEM_Payment::status_id_failed               => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			// following statuses are NOT part of the EEM_Status but to keep things centralized we include in here.
+			EEM_Event::sold_out                         => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EEM_Event::postponed                        => [
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('Postponed', 'event_espresso'),
+			],
+			EEM_Event::cancelled                        => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EE_Ticket::archived                         => [
+				esc_html__('archived', 'event_espresso'),
+				esc_html__('archived', 'event_espresso'),
+			],
+			EE_Ticket::expired                          => [
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			],
+			EE_Ticket::sold_out                         => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EE_Ticket::pending                          => [
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			],
+			EE_Ticket::onsale                           => [
+				esc_html__('on sale', 'event_espresso'),
+				esc_html__('on sale', 'event_espresso'),
+			],
+			EE_Datetime::cancelled                      => [
+				esc_html__('cancelled', 'event_espresso'),
+				esc_html__('cancelled', 'event_espresso'),
+			],
+			EE_Datetime::sold_out                       => [
+				esc_html__('sold out', 'event_espresso'),
+				esc_html__('sold out', 'event_espresso'),
+			],
+			EE_Datetime::expired                        => [
+				esc_html__('expired', 'event_espresso'),
+				esc_html__('expired', 'event_espresso'),
+			],
+			EE_Datetime::inactive                       => [
+				esc_html__('inactive', 'event_espresso'),
+				esc_html__('inactive', 'event_espresso'),
+			],
+			EE_Datetime::upcoming                       => [
+				esc_html__('upcoming', 'event_espresso'),
+				esc_html__('upcoming', 'event_espresso'),
+			],
+			EE_Datetime::active                         => [
+				esc_html__('active', 'event_espresso'),
+				esc_html__('active', 'event_espresso'),
+			],
+			EE_Datetime::postponed                      => [
+				esc_html__('postponed', 'event_espresso'),
+				esc_html__('postponed', 'event_espresso'),
+			],
+			// messages related
+			EEM_Message::status_sent                    => [
+				esc_html__('sent', 'event_espresso'),
+				esc_html__('sent', 'event_espresso'),
+			],
+			EEM_Message::status_idle                    => [
+				esc_html__('queued for sending', 'event_espresso'),
+				esc_html__('queued for sending', 'event_espresso'),
+			],
+			EEM_Message::status_failed                  => [
+				esc_html__('failed', 'event_espresso'),
+				esc_html__('failed', 'event_espresso'),
+			],
+			EEM_Message::status_debug_only              => [
+				esc_html__('debug only', 'event_espresso'),
+				esc_html__('debug only', 'event_espresso'),
+			],
+			EEM_Message::status_messenger_executing     => [
+				esc_html__('messenger is executing', 'event_espresso'),
+				esc_html__('messenger is executing', 'event_espresso'),
+			],
+			EEM_Message::status_resend                  => [
+				esc_html__('queued for resending', 'event_espresso'),
+				esc_html__('queued for resending', 'event_espresso'),
+			],
+			EEM_Message::status_incomplete              => [
+				esc_html__('queued for generating', 'event_espresso'),
+				esc_html__('queued for generating', 'event_espresso'),
+			],
+			EEM_Message::status_retry                   => [
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+				esc_html__('failed sending, can be retried', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_publish           => [
+				esc_html__('published', 'event_espresso'),
+				esc_html__('published', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_future            => [
+				esc_html__('scheduled', 'event_espresso'),
+				esc_html__('scheduled', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_draft             => [
+				esc_html__('draft', 'event_espresso'),
+				esc_html__('draft', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_pending           => [
+				esc_html__('pending', 'event_espresso'),
+				esc_html__('pending', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_private           => [
+				esc_html__('private', 'event_espresso'),
+				esc_html__('private', 'event_espresso'),
+			],
+			EEM_CPT_Base::post_status_trashed           => [
+				esc_html__('trashed', 'event_espresso'),
+				esc_html__('trashed', 'event_espresso'),
+			],
+		];
 
-        $translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
+		$translation_array = apply_filters('FHEE__EEM_Status__localized_status__translation_array', $translation_array);
 
-        if (! is_array($statuses)) {
-            throw new EE_Error(
-                esc_html__(
-                    'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
-                    'event_espresso'
-                )
-            );
-        }
+		if (! is_array($statuses)) {
+			throw new EE_Error(
+				esc_html__(
+					'The incoming statuses argument must be an array with keys as the $status_id and values as the $status_code',
+					'event_espresso'
+				)
+			);
+		}
 
-        $translation = [];
+		$translation = [];
 
-        foreach ($statuses as $id => $code) {
-            if (isset($translation_array[ $id ])) {
-                $translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
-            } else {
-                $translation[ $id ] = $code;
-            }
+		foreach ($statuses as $id => $code) {
+			if (isset($translation_array[ $id ])) {
+				$translation[ $id ] = $plural ? $translation_array[ $id ][1] : $translation_array[ $id ][0];
+			} else {
+				$translation[ $id ] = $code;
+			}
 
-            // schema
-            switch ($schema) {
-                case 'lower':
-                    $translation[ $id ] = strtolower(
-                        $translation[ $id ]
-                    ); // even though these start in lower case, this will catch any statuses added via filter.
-                    break;
-                case 'sentence':
-                    $translation[ $id ] = ucwords($translation[ $id ]);
-                    break;
-                case 'upper':
-                    $translation[ $id ] = strtoupper($translation[ $id ]);
-                    break;
-            }
-        }
+			// schema
+			switch ($schema) {
+				case 'lower':
+					$translation[ $id ] = strtolower(
+						$translation[ $id ]
+					); // even though these start in lower case, this will catch any statuses added via filter.
+					break;
+				case 'sentence':
+					$translation[ $id ] = ucwords($translation[ $id ]);
+					break;
+				case 'upper':
+					$translation[ $id ] = strtoupper($translation[ $id ]);
+					break;
+			}
+		}
 
-        return $translation;
-    }
+		return $translation;
+	}
 }

core/db_models/EEM_WP_User.model.php

Indentation +114 added lines, -114 removed lines

@@ -12,124 +12,124 @@
  */
 class EEM_WP_User extends EEM_Base
 {
-    protected static ?EEM_WP_User $_instance = null;
+	protected static ?EEM_WP_User $_instance = null;
 
 
-    /**
-     * @param string|null            $timezone
-     * @param ModelFieldFactory|null $model_field_factory
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '', ModelFieldFactory $model_field_factory = null)
-    {
-        $this->singular_item = esc_html__('WP_User', 'event_espresso');
-        $this->plural_item   = esc_html__('WP_Users', 'event_espresso');
-        global $wpdb;
-        $this->_tables                                                      = [
-            'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
-        ];
-        $this->_fields                                                      = [
-            'WP_User' => [
-                'ID'                  => $model_field_factory->createPrimaryKeyIntField(
-                    'ID',
-                    esc_html__('WP_User ID', 'event_espresso')
-                ),
-                'user_login'          => $model_field_factory->createPlainTextField(
-                    'user_login',
-                    esc_html__('User Login', 'event_espresso'),
-                    false
-                ),
-                'user_pass'           => $model_field_factory->createPlainTextField(
-                    'user_pass',
-                    esc_html__('User Password', 'event_espresso'),
-                    false
-                ),
-                'user_nicename'       => $model_field_factory->createPlainTextField(
-                    'user_nicename',
-                    esc_html__(' User Nice Name', 'event_espresso'),
-                    false
-                ),
-                'user_email'          => $model_field_factory->createEmailField(
-                    'user_email',
-                    esc_html__('User Email', 'event_espresso'),
-                    false
-                ),
-                'user_registered'     => $model_field_factory->createDatetimeField(
-                    'user_registered',
-                    esc_html__('Date User Registered', 'event_espresso'),
-                    $timezone
-                ),
-                'user_activation_key' => $model_field_factory->createPlainTextField(
-                    'user_activation_key',
-                    esc_html__('User Activation Key', 'event_espresso'),
-                    false
-                ),
-                'user_status'         => $model_field_factory->createIntegerField(
-                    'user_status',
-                    esc_html__('User Status', 'event_espresso')
-                ),
-                'display_name'        => $model_field_factory->createPlainTextField(
-                    'display_name',
-                    esc_html__('Display Name', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-        $this->_model_relations                                             = [
-            'Attendee'       => new EE_Has_Many_Relation(),
-            // all models are related to the change log
-            // 'Change_Log'     => new EE_Has_Many_Relation(),
-            'Event'          => new EE_Has_Many_Relation(),
-            'Message'        => new EE_Has_Many_Relation(),
-            'Payment_Method' => new EE_Has_Many_Relation(),
-            'Price'          => new EE_Has_Many_Relation(),
-            'Price_Type'     => new EE_Has_Many_Relation(),
-            'Question'       => new EE_Has_Many_Relation(),
-            'Question_Group' => new EE_Has_Many_Relation(),
-            'Ticket'         => new EE_Has_Many_Relation(),
-            'Venue'          => new EE_Has_Many_Relation(),
-        ];
-        $this->foreign_key_aliases                                          = [
-            'Event.EVT_wp_user'          => 'WP_User.ID',
-            'Payment_Method.PMD_wp_user' => 'WP_User.ID',
-            'Price.PRC_wp_user'          => 'WP_User.ID',
-            'Price_Type.PRT_wp_user'     => 'WP_User.ID',
-            'Question.QST_wp_user'       => 'WP_User.ID',
-            'Question_Group.QSG_wp_user' => 'WP_User.ID',
-            'Ticket.VNU_wp_user'         => 'WP_User.ID',
-            'Venue.TKT_wp_user'          => 'WP_User.ID',
-        ];
-        $this->_wp_core_model                                               = true;
-        $this->_caps_slug                                                   = 'users';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ]       = 'list';
-        $this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
-        foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
-            $this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
-        }
-        // @todo: account for create_users controls whether they can create users at all
-        parent::__construct($timezone);
-    }
+	/**
+	 * @param string|null            $timezone
+	 * @param ModelFieldFactory|null $model_field_factory
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '', ModelFieldFactory $model_field_factory = null)
+	{
+		$this->singular_item = esc_html__('WP_User', 'event_espresso');
+		$this->plural_item   = esc_html__('WP_Users', 'event_espresso');
+		global $wpdb;
+		$this->_tables                                                      = [
+			'WP_User' => new EE_Primary_Table($wpdb->users, 'ID', true),
+		];
+		$this->_fields                                                      = [
+			'WP_User' => [
+				'ID'                  => $model_field_factory->createPrimaryKeyIntField(
+					'ID',
+					esc_html__('WP_User ID', 'event_espresso')
+				),
+				'user_login'          => $model_field_factory->createPlainTextField(
+					'user_login',
+					esc_html__('User Login', 'event_espresso'),
+					false
+				),
+				'user_pass'           => $model_field_factory->createPlainTextField(
+					'user_pass',
+					esc_html__('User Password', 'event_espresso'),
+					false
+				),
+				'user_nicename'       => $model_field_factory->createPlainTextField(
+					'user_nicename',
+					esc_html__(' User Nice Name', 'event_espresso'),
+					false
+				),
+				'user_email'          => $model_field_factory->createEmailField(
+					'user_email',
+					esc_html__('User Email', 'event_espresso'),
+					false
+				),
+				'user_registered'     => $model_field_factory->createDatetimeField(
+					'user_registered',
+					esc_html__('Date User Registered', 'event_espresso'),
+					$timezone
+				),
+				'user_activation_key' => $model_field_factory->createPlainTextField(
+					'user_activation_key',
+					esc_html__('User Activation Key', 'event_espresso'),
+					false
+				),
+				'user_status'         => $model_field_factory->createIntegerField(
+					'user_status',
+					esc_html__('User Status', 'event_espresso')
+				),
+				'display_name'        => $model_field_factory->createPlainTextField(
+					'display_name',
+					esc_html__('Display Name', 'event_espresso'),
+					false
+				),
+			],
+		];
+		$this->_model_relations                                             = [
+			'Attendee'       => new EE_Has_Many_Relation(),
+			// all models are related to the change log
+			// 'Change_Log'     => new EE_Has_Many_Relation(),
+			'Event'          => new EE_Has_Many_Relation(),
+			'Message'        => new EE_Has_Many_Relation(),
+			'Payment_Method' => new EE_Has_Many_Relation(),
+			'Price'          => new EE_Has_Many_Relation(),
+			'Price_Type'     => new EE_Has_Many_Relation(),
+			'Question'       => new EE_Has_Many_Relation(),
+			'Question_Group' => new EE_Has_Many_Relation(),
+			'Ticket'         => new EE_Has_Many_Relation(),
+			'Venue'          => new EE_Has_Many_Relation(),
+		];
+		$this->foreign_key_aliases                                          = [
+			'Event.EVT_wp_user'          => 'WP_User.ID',
+			'Payment_Method.PMD_wp_user' => 'WP_User.ID',
+			'Price.PRC_wp_user'          => 'WP_User.ID',
+			'Price_Type.PRT_wp_user'     => 'WP_User.ID',
+			'Question.QST_wp_user'       => 'WP_User.ID',
+			'Question_Group.QSG_wp_user' => 'WP_User.ID',
+			'Ticket.VNU_wp_user'         => 'WP_User.ID',
+			'Venue.TKT_wp_user'          => 'WP_User.ID',
+		];
+		$this->_wp_core_model                                               = true;
+		$this->_caps_slug                                                   = 'users';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read ]       = 'list';
+		$this->_cap_contexts_to_cap_action_map[ EEM_Base::caps_read_admin ] = 'list';
+		foreach ($this->_cap_contexts_to_cap_action_map as $context => $action) {
+			$this->_cap_restriction_generators[ $context ] = new EE_Restriction_Generator_WP_User();
+		}
+		// @todo: account for create_users controls whether they can create users at all
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * We don't need a foreign key to the WP_User model, we just need its primary key
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function wp_user_field_name()
-    {
-        return $this->primary_key_name();
-    }
+	/**
+	 * We don't need a foreign key to the WP_User model, we just need its primary key
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function wp_user_field_name()
+	{
+		return $this->primary_key_name();
+	}
 
 
-    /**
-     * This WP_User model IS owned, even though it doesn't have a foreign key to itself
-     *
-     * @return boolean
-     */
-    public function is_owned()
-    {
-        return true;
-    }
+	/**
+	 * This WP_User model IS owned, even though it doesn't have a foreign key to itself
+	 *
+	 * @return boolean
+	 */
+	public function is_owned()
+	{
+		return true;
+	}
 }

core/db_models/EEM_Payment.model.php

Indentation +338 added lines, -338 removed lines

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

core/db_models/EEM_Form_Element.model.php

Indentation +224 added lines, -224 removed lines

@@ -26,228 +26,228 @@
  */
 class EEM_Form_Element extends EEM_Base
 {
-    protected static ?EEM_Form_Element $_instance = null;
-
-    private RequestInterface $request;
-
-    private InputTypes $input_types;
-
-
-    /**
-     * EEM_Form_Element constructor.
-     *
-     * @param FormStatus  $form_status
-     * @param InputTypes  $input_types
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(FormStatus $form_status, InputTypes $input_types, ?string $timezone = '')
-    {
-        $this->input_types   = $input_types;
-        $this->singular_item = esc_html__('Form Element', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Elements', 'event_espresso');
-
-        $this->_tables = [
-            'Form_Element' => new EE_Primary_Table('esp_form_element', 'FIN_UUID'),
-        ];
-        $this->_fields = [
-            'Form_Element' => [
-                'FIN_UUID'       => new EE_Primary_Key_String_Field(
-                    'FIN_UUID',
-                    esc_html__('Form Element UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_UUID'       => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('UUID of parent form section this form input belongs to.', 'event_espresso'),
-                    false,
-                    null,
-                    ['Form_Section'],
-                    false
-                ),
-                'FIN_adminOnly'  => new EE_Boolean_Field(
-                    'FIN_adminOnly',
-                    esc_html__(
-                        'Whether or not input is only displayed in the admin. If false, input will appear in public forms',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'FIN_attributes' => new EE_JSON_Field(
-                    'FIN_attributes',
-                    esc_html__(
-                        'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_helpText'   => new EE_JSON_Field(
-                    'FIN_helpText',
-                    esc_html__(
-                        'JSON string of properties pertaining to any help text required for an input.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_label'      => new EE_JSON_Field(
-                    'FIN_label',
-                    esc_html__(
-                        'JSON string of properties pertaining to an element\'s label.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '{}'
-                ),
-                'FIN_mapsTo'     => new EE_Plain_Text_Field(
-                    'FIN_mapsTo',
-                    esc_html__(
-                        'Model and Fields name that this element maps to; ex: Attendee.email',
-                        'event_espresso'
-                    ),
-                    true,
-                    null
-                ),
-                'FIN_options'    => new EE_JSON_Field(
-                    'FIN_options',
-                    esc_html__(
-                        'JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.',
-                        'event_espresso'
-                    ),
-                    true,
-                    '[]'
-                ),
-                'FIN_order'      => new EE_Integer_Field(
-                    'FIN_order',
-                    esc_html__('Order in which form input appears in a form.', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'FIN_required'   => new EE_JSON_Field(
-                    'FIN_required',
-                    esc_html__(
-                        'properties pertaining to an input\'s required status and the validation text to display.',
-                        'event_espresso'
-                    ),
-                    false,
-                    false
-                ),
-                'FIN_status'     => new EE_Enum_Text_Field(
-                    'FIN_status',
-                    esc_html(
-                        sprintf(
-                        /* translators: 1 class name */
-                            __(
-                                'Whether form element is active, archived, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
-                                'event_espresso'
-                            ),
-                            'EventEspresso\core\services\form\meta\FormStatus'
-                        )
-                    ),
-                    false,
-                    FormStatus::ACTIVE,
-                    $form_status->validStatusOptions()
-                ),
-                'FIN_type'       => new EE_Enum_Text_Field(
-                    'FIN_type',
-                    esc_html__('Form element type.', 'event_espresso'),
-                    false,
-                    null,
-                    $input_types->validTypeOptions()
-                ),
-                'FIN_wpUser'     => new EE_WP_User_Field(
-                    'FIN_wpUser',
-                    esc_html__('ID of the WP User that created this form input.', 'event_espresso'),
-                    false
-                ),
-            ],
-        ];
-
-        $this->_model_relations = [
-            'Form_Section' => new EE_Belongs_To_Relation(),
-            'WP_User'      => new EE_Belongs_To_Relation(),
-        ];
-        // this model is generally available for reading
-        $this->_cap_restriction_generators = [
-            EEM_Base::caps_read       => new EE_Restriction_Generator_Public(),
-            EEM_Base::caps_read_admin => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-            EEM_Base::caps_edit       => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-            EEM_Base::caps_delete     => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
-        ];
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
-
-
-    /**
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
-        $query_params['default_where_conditions'] = $admin_request
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
-
-
-    /**
-     * form inputs should always be sorted in ascending order via the FIN_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FIN_order' => 'ASC'];
-        return $query_params;
-    }
-
-
-    /**
-     * @param EE_Form_Section   $form_section
-     * @param EE_Form_Element[] $all_form_elements
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function filterFormElementsForFormSection(EE_Form_Section $form_section, array $all_form_elements): array
-    {
-        return array_filter($all_form_elements, $form_section->formElementFilter());
-    }
-
-
-    /**
-     * @param EE_Form_Section[] $form_sections
-     * @return EE_Form_Element[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllFormElementsForFormSections(array $form_sections): array
-    {
-        $FSC_UUIDs = [];
-        foreach ($form_sections as $form_section) {
-            if ($form_section instanceof EE_Form_Section) {
-                $FSC_UUIDs[] = $form_section->UUID();
-            }
-        }
-        $where_params = ['FSC_UUID' => ['IN', $FSC_UUIDs]];
-        $query_params = $this->addDefaultWhereConditions([$where_params]);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
-
-
-    /**
-     * @param bool $constants_only
-     * @return array
-     */
-    public function validTypeOptions(bool $constants_only = false): array
-    {
-        return $this->input_types->validTypeOptions($constants_only);
-    }
+	protected static ?EEM_Form_Element $_instance = null;
+
+	private RequestInterface $request;
+
+	private InputTypes $input_types;
+
+
+	/**
+	 * EEM_Form_Element constructor.
+	 *
+	 * @param FormStatus  $form_status
+	 * @param InputTypes  $input_types
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(FormStatus $form_status, InputTypes $input_types, ?string $timezone = '')
+	{
+		$this->input_types   = $input_types;
+		$this->singular_item = esc_html__('Form Element', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Elements', 'event_espresso');
+
+		$this->_tables = [
+			'Form_Element' => new EE_Primary_Table('esp_form_element', 'FIN_UUID'),
+		];
+		$this->_fields = [
+			'Form_Element' => [
+				'FIN_UUID'       => new EE_Primary_Key_String_Field(
+					'FIN_UUID',
+					esc_html__('Form Element UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_UUID'       => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('UUID of parent form section this form input belongs to.', 'event_espresso'),
+					false,
+					null,
+					['Form_Section'],
+					false
+				),
+				'FIN_adminOnly'  => new EE_Boolean_Field(
+					'FIN_adminOnly',
+					esc_html__(
+						'Whether or not input is only displayed in the admin. If false, input will appear in public forms',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'FIN_attributes' => new EE_JSON_Field(
+					'FIN_attributes',
+					esc_html__(
+						'JSON string of HTML attributes such as class, max, min, placeholder, type, etc.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_helpText'   => new EE_JSON_Field(
+					'FIN_helpText',
+					esc_html__(
+						'JSON string of properties pertaining to any help text required for an input.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_label'      => new EE_JSON_Field(
+					'FIN_label',
+					esc_html__(
+						'JSON string of properties pertaining to an element\'s label.',
+						'event_espresso'
+					),
+					true,
+					'{}'
+				),
+				'FIN_mapsTo'     => new EE_Plain_Text_Field(
+					'FIN_mapsTo',
+					esc_html__(
+						'Model and Fields name that this element maps to; ex: Attendee.email',
+						'event_espresso'
+					),
+					true,
+					null
+				),
+				'FIN_options'    => new EE_JSON_Field(
+					'FIN_options',
+					esc_html__(
+						'JSON string of options for ENUM type inputs like checkboxes, radio buttons, select inputs, etc.',
+						'event_espresso'
+					),
+					true,
+					'[]'
+				),
+				'FIN_order'      => new EE_Integer_Field(
+					'FIN_order',
+					esc_html__('Order in which form input appears in a form.', 'event_espresso'),
+					false,
+					0
+				),
+				'FIN_required'   => new EE_JSON_Field(
+					'FIN_required',
+					esc_html__(
+						'properties pertaining to an input\'s required status and the validation text to display.',
+						'event_espresso'
+					),
+					false,
+					false
+				),
+				'FIN_status'     => new EE_Enum_Text_Field(
+					'FIN_status',
+					esc_html(
+						sprintf(
+						/* translators: 1 class name */
+							__(
+								'Whether form element is active, archived, trashed, or used as a default on new forms. Values correspond to the %1$s class constants.',
+								'event_espresso'
+							),
+							'EventEspresso\core\services\form\meta\FormStatus'
+						)
+					),
+					false,
+					FormStatus::ACTIVE,
+					$form_status->validStatusOptions()
+				),
+				'FIN_type'       => new EE_Enum_Text_Field(
+					'FIN_type',
+					esc_html__('Form element type.', 'event_espresso'),
+					false,
+					null,
+					$input_types->validTypeOptions()
+				),
+				'FIN_wpUser'     => new EE_WP_User_Field(
+					'FIN_wpUser',
+					esc_html__('ID of the WP User that created this form input.', 'event_espresso'),
+					false
+				),
+			],
+		];
+
+		$this->_model_relations = [
+			'Form_Section' => new EE_Belongs_To_Relation(),
+			'WP_User'      => new EE_Belongs_To_Relation(),
+		];
+		// this model is generally available for reading
+		$this->_cap_restriction_generators = [
+			EEM_Base::caps_read       => new EE_Restriction_Generator_Public(),
+			EEM_Base::caps_read_admin => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+			EEM_Base::caps_edit       => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+			EEM_Base::caps_delete     => new EE_Restriction_Generator_Reg_Form('FIN_applies_to'),
+		];
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
+
+
+	/**
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$admin_request                            = $this->request->isAdmin() || $this->request->isAdminAjax();
+		$query_params['default_where_conditions'] = $admin_request
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
+
+
+	/**
+	 * form inputs should always be sorted in ascending order via the FIN_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FIN_order' => 'ASC'];
+		return $query_params;
+	}
+
+
+	/**
+	 * @param EE_Form_Section   $form_section
+	 * @param EE_Form_Element[] $all_form_elements
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function filterFormElementsForFormSection(EE_Form_Section $form_section, array $all_form_elements): array
+	{
+		return array_filter($all_form_elements, $form_section->formElementFilter());
+	}
+
+
+	/**
+	 * @param EE_Form_Section[] $form_sections
+	 * @return EE_Form_Element[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllFormElementsForFormSections(array $form_sections): array
+	{
+		$FSC_UUIDs = [];
+		foreach ($form_sections as $form_section) {
+			if ($form_section instanceof EE_Form_Section) {
+				$FSC_UUIDs[] = $form_section->UUID();
+			}
+		}
+		$where_params = ['FSC_UUID' => ['IN', $FSC_UUIDs]];
+		$query_params = $this->addDefaultWhereConditions([$where_params]);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
+
+
+	/**
+	 * @param bool $constants_only
+	 * @return array
+	 */
+	public function validTypeOptions(bool $constants_only = false): array
+	{
+		return $this->input_types->validTypeOptions($constants_only);
+	}
 }

core/db_models/EEM_Checkin.model.php

Indentation +60 added lines, -60 removed lines

@@ -10,67 +10,67 @@
  */
 class EEM_Checkin extends EEM_Base
 {
-    protected static ?EEM_Checkin $_instance = null;
+	protected static ?EEM_Checkin $_instance = null;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings
-     *                              (and any incoming timezone data that gets saved).
-     *                              Note this just sends the timezone info to the date time model field objects.
-     *                              Default is NULL
-     *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    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.
+	 *                              Default is NULL
+	 *                              (and will be assumed using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('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);
+	}
 }

core/db_models/EEM_Question_Option.model.php

Indentation +73 added lines, -73 removed lines

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

core/db_models/EEM_Term_Taxonomy.model.php

Indentation +126 added lines, -126 removed lines

@@ -10,136 +10,136 @@
  */
 class EEM_Term_Taxonomy extends EEM_Base
 {
-    protected static ?EEM_Term_Taxonomy $_instance = null;
+	protected static ?EEM_Term_Taxonomy $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Term Taxonomy', 'event_espresso');
-        $this->plural_item      = esc_html__('Term Taxonomy', 'event_espresso');
-        $this->_tables          = [
-            'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
-        ];
-        $this->_fields          = [
-            'Term_Taxonomy' => [
-                'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
-                    'term_taxonomy_id',
-                    esc_html__('Term-Taxonomy ID', 'event_espresso')
-                ),
-                'term_id'          => new EE_Foreign_Key_Int_Field(
-                    'term_id',
-                    esc_html__("Term Id", "event_espresso"),
-                    false,
-                    0,
-                    'Term'
-                ),
-                'taxonomy'         => new EE_Plain_Text_Field(
-                    'taxonomy',
-                    esc_html__('Taxonomy Name', 'event_espresso'),
-                    false,
-                    'category'
-                ),
-                'description'      => new EE_Post_Content_Field(
-                    'description',
-                    esc_html__("Description of Term", "event_espresso"),
-                    false,
-                    ''
-                ),
-                'parent'           => new EE_Integer_Field(
-                    'parent',
-                    esc_html__("Parent Term ID", "event_espresso"),
-                    false,
-                    0
-                ),
-                'term_count'       => new EE_Integer_Field(
-                    'count',
-                    esc_html__("Count of Objects attached", 'event_espresso'),
-                    false,
-                    0
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Term_Relationship' => new EE_Has_Many_Relation(),
-            'Term'              => new EE_Belongs_To_Relation(),
-        ];
-        $cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
-        foreach ($cpt_models as $model_name) {
-            $this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
-        }
-        $this->_wp_core_model                                           = true;
-        $this->_indexes                                                 = [
-            'term_id_taxonomy' => new EE_Unique_Index(['term_id', 'taxonomy']),
-        ];
-        $path_to_tax_model                                              = '';
-        $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_Taxonomy_Protected(
-                $path_to_tax_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', ['EEM_Term_Taxonomy', 'rest_api_query_params'], 10, 3);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Term Taxonomy', 'event_espresso');
+		$this->plural_item      = esc_html__('Term Taxonomy', 'event_espresso');
+		$this->_tables          = [
+			'Term_Taxonomy' => new EE_Primary_Table('term_taxonomy', 'term_taxonomy_id'),
+		];
+		$this->_fields          = [
+			'Term_Taxonomy' => [
+				'term_taxonomy_id' => new EE_Primary_Key_Int_Field(
+					'term_taxonomy_id',
+					esc_html__('Term-Taxonomy ID', 'event_espresso')
+				),
+				'term_id'          => new EE_Foreign_Key_Int_Field(
+					'term_id',
+					esc_html__("Term Id", "event_espresso"),
+					false,
+					0,
+					'Term'
+				),
+				'taxonomy'         => new EE_Plain_Text_Field(
+					'taxonomy',
+					esc_html__('Taxonomy Name', 'event_espresso'),
+					false,
+					'category'
+				),
+				'description'      => new EE_Post_Content_Field(
+					'description',
+					esc_html__("Description of Term", "event_espresso"),
+					false,
+					''
+				),
+				'parent'           => new EE_Integer_Field(
+					'parent',
+					esc_html__("Parent Term ID", "event_espresso"),
+					false,
+					0
+				),
+				'term_count'       => new EE_Integer_Field(
+					'count',
+					esc_html__("Count of Objects attached", 'event_espresso'),
+					false,
+					0
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Term_Relationship' => new EE_Has_Many_Relation(),
+			'Term'              => new EE_Belongs_To_Relation(),
+		];
+		$cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
+		foreach ($cpt_models as $model_name) {
+			$this->_model_relations[ $model_name ] = new EE_HABTM_Relation('Term_Relationship');
+		}
+		$this->_wp_core_model                                           = true;
+		$this->_indexes                                                 = [
+			'term_id_taxonomy' => new EE_Unique_Index(['term_id', 'taxonomy']),
+		];
+		$path_to_tax_model                                              = '';
+		$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_Taxonomy_Protected(
+				$path_to_tax_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', ['EEM_Term_Taxonomy', 'rest_api_query_params'], 10, 3);
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return term-taxonomies
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     * @throws EE_Error
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term_Taxonomy::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return term-taxonomies
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term_Taxonomy::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }
 // End of file EEM_Term_Taxonomy.model.php
 // Location: /includes/models/EEM_Term_Taxonomy.model.php

core/db_models/EEM_Post_Meta.model.php

Indentation +52 added lines, -52 removed lines

@@ -17,58 +17,58 @@
  */
 class EEM_Post_Meta extends EEM_Base
 {
-    protected static ?EEM_Post_Meta $_instance = null;
+	protected static ?EEM_Post_Meta $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    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             = [
-            'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
-        ];
-        $models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
-        $this->_fields             = [
-            'Post_Meta' => [
-                '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    = [];
-        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);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	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             = [
+			'Post_Meta' => new EE_Primary_Table('postmeta', 'meta_id'),
+		];
+		$models_this_can_attach_to = array_keys(EE_Registry::instance()->cpt_models());
+		$this->_fields             = [
+			'Post_Meta' => [
+				'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    = [];
+		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_Term.model.php

Indentation +247 added lines, -247 removed lines

@@ -11,269 +11,269 @@
  */
 class EEM_Term extends EEM_Base
 {
-    protected static ?EEM_Term $_instance = null;
+	protected static ?EEM_Term $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item                                            = esc_html__('Term', 'event_espresso');
-        $this->plural_item                                              = esc_html__('Terms', 'event_espresso');
-        $this->_tables                                                  = [
-            'Term' => new EE_Primary_Table('terms', 'term_id'),
-        ];
-        $this->_fields                                                  = [
-            'Term' => [
-                'term_id'    => new EE_Primary_Key_Int_Field('term_id', esc_html__('Term ID', 'event_espresso')),
-                'name'       => new EE_Plain_Text_Field('name', esc_html__('Term Name', 'event_espresso'), false, ''),
-                'slug'       => new EE_Slug_Field('slug', esc_html__('Term Slug', 'event_espresso'), false),
-                'term_group' => new EE_Integer_Field(
-                    'term_group', esc_html__("Term Group", "event_espresso"), false, 0
-                ),
-            ],
-        ];
-        $this->_model_relations                                         = [
-            'Term_Taxonomy' => new EE_Has_Many_Relation(),
-        ];
-        $this->_wp_core_model                                           = true;
-        $path_to_tax_model                                              = 'Term_Taxonomy';
-        $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_Taxonomy_Protected(
-                $path_to_tax_model
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
-        $path_to_tax_model                                              = $path_to_tax_model . '.';
-        // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
-            ]
-        );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
-            [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
-            ]
-        );
-        parent::__construct($timezone);
-        add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
-    }
+	/**
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item                                            = esc_html__('Term', 'event_espresso');
+		$this->plural_item                                              = esc_html__('Terms', 'event_espresso');
+		$this->_tables                                                  = [
+			'Term' => new EE_Primary_Table('terms', 'term_id'),
+		];
+		$this->_fields                                                  = [
+			'Term' => [
+				'term_id'    => new EE_Primary_Key_Int_Field('term_id', esc_html__('Term ID', 'event_espresso')),
+				'name'       => new EE_Plain_Text_Field('name', esc_html__('Term Name', 'event_espresso'), false, ''),
+				'slug'       => new EE_Slug_Field('slug', esc_html__('Term Slug', 'event_espresso'), false),
+				'term_group' => new EE_Integer_Field(
+					'term_group', esc_html__("Term Group", "event_espresso"), false, 0
+				),
+			],
+		];
+		$this->_model_relations                                         = [
+			'Term_Taxonomy' => new EE_Has_Many_Relation(),
+		];
+		$this->_wp_core_model                                           = true;
+		$path_to_tax_model                                              = 'Term_Taxonomy';
+		$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_Taxonomy_Protected(
+				$path_to_tax_model
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
+		$path_to_tax_model                                              = $path_to_tax_model . '.';
+		// add cap restrictions for editing relating to the "ee_edit_*"
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		// add cap restrictions for deleting relating to the "ee_deleting_*"
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+			]
+		);
+		$this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+			[
+				$path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+			]
+		);
+		parent::__construct($timezone);
+		add_filter('FHEE__Read__create_model_query_params', ['EEM_Term', 'rest_api_query_params'], 10, 3);
+	}
 
 
-    /**
-     * retrieves a list of all EE event categories
-     *
-     * @access public
-     * @param bool $show_uncategorized
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_ee_categories($show_uncategorized = false)
-    {
-        $where_params = [
-            'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
-            'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
-        ];
-        if ($show_uncategorized) {
-            unset($where_params['NOT']);
-        }
-        return EEM_Term::instance()->get_all(
-            [
-                $where_params,
-                'order_by' => ['name' => 'ASC'],
-            ]
-        );
-    }
+	/**
+	 * retrieves a list of all EE event categories
+	 *
+	 * @access public
+	 * @param bool $show_uncategorized
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_ee_categories($show_uncategorized = false)
+	{
+		$where_params = [
+			'Term_Taxonomy.taxonomy' => 'espresso_event_categories',
+			'NOT'                    => ['name' => esc_html__('Uncategorized', 'event_espresso')],
+		];
+		if ($show_uncategorized) {
+			unset($where_params['NOT']);
+		}
+		return EEM_Term::instance()->get_all(
+			[
+				$where_params,
+				'order_by' => ['name' => 'ASC'],
+			]
+		);
+	}
 
 
-    /**
-     * retrieves a list of all post_tags associated with an EE CPT
-     *
-     * @access public
-     * @param string $post_type
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_CPT_post_tags($post_type = '')
-    {
-        switch ($post_type) {
-            case EspressoPostType::EVENTS:
-                return $this->get_all_event_post_tags();
+	/**
+	 * retrieves a list of all post_tags associated with an EE CPT
+	 *
+	 * @access public
+	 * @param string $post_type
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_CPT_post_tags($post_type = '')
+	{
+		switch ($post_type) {
+			case EspressoPostType::EVENTS:
+				return $this->get_all_event_post_tags();
 
-            case EspressoPostType::VENUES:
-                return $this->get_all_venue_post_tags();
+			case EspressoPostType::VENUES:
+				return $this->get_all_venue_post_tags();
 
-            default:
-                $event_tags = $this->get_all_event_post_tags();
-                $venue_tags = $this->get_all_venue_post_tags();
-                return array_merge($event_tags, $venue_tags);
-        }
-    }
+			default:
+				$event_tags = $this->get_all_event_post_tags();
+				$venue_tags = $this->get_all_venue_post_tags();
+				return array_merge($event_tags, $venue_tags);
+		}
+	}
 
 
-    /**
-     * returns an EE_Term object for the given tag
-     * if it has been utilized by any EE_Events or EE_Venues
-     *
-     * @param string $tag
-     * @return EE_Term|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_post_tag_for_event_or_venue($tag)
-    {
-        $post_tag_results = $this->get_all_wpdb_results(
-            [
-                [
-                    'slug'                   => $tag,
-                    'Term_Taxonomy.taxonomy' => 'post_tag',
-                    'OR'                     => [
-                        'Term_Taxonomy.Venue.post_type' => EspressoPostType::VENUES,
-                        'Term_Taxonomy.Event.post_type' => EspressoPostType::EVENTS,
-                    ],
-                ],
-                'default_where_conditions' => 'none',
-                'extra_selects'            => [
-                    'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
-                    'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
-                ],
-                'group_by'                 => [
-                    'event_post_type',
-                    'venue_post_type',
-                ],
-                'limit'                    => 2,
-            ]
-        );
-        if (! $post_tag_results) {
-            return null;
-        }
+	/**
+	 * returns an EE_Term object for the given tag
+	 * if it has been utilized by any EE_Events or EE_Venues
+	 *
+	 * @param string $tag
+	 * @return EE_Term|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_post_tag_for_event_or_venue($tag)
+	{
+		$post_tag_results = $this->get_all_wpdb_results(
+			[
+				[
+					'slug'                   => $tag,
+					'Term_Taxonomy.taxonomy' => 'post_tag',
+					'OR'                     => [
+						'Term_Taxonomy.Venue.post_type' => EspressoPostType::VENUES,
+						'Term_Taxonomy.Event.post_type' => EspressoPostType::EVENTS,
+					],
+				],
+				'default_where_conditions' => 'none',
+				'extra_selects'            => [
+					'event_post_type' => ['Term_Taxonomy___Event_CPT.post_type', '%s'],
+					'venue_post_type' => ['Term_Taxonomy___Venue_CPT.post_type', '%s'],
+				],
+				'group_by'                 => [
+					'event_post_type',
+					'venue_post_type',
+				],
+				'limit'                    => 2,
+			]
+		);
+		if (! $post_tag_results) {
+			return null;
+		}
 
-        $post_types = [];
-        foreach ((array) $post_tag_results as $row) {
-            if ($row['event_post_type'] === EspressoPostType::EVENTS) {
-                $post_types[] = EEM_Event::instance()->post_type();
-            } elseif ($row['venue_post_type'] === EspressoPostType::VENUES) {
-                $post_types[] = EEM_Venue::instance()->post_type();
-            }
-        }
-        $post_tag_row = reset($post_tag_results);
-        $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
-            return null;
-        }
+		$post_types = [];
+		foreach ((array) $post_tag_results as $row) {
+			if ($row['event_post_type'] === EspressoPostType::EVENTS) {
+				$post_types[] = EEM_Event::instance()->post_type();
+			} elseif ($row['venue_post_type'] === EspressoPostType::VENUES) {
+				$post_types[] = EEM_Venue::instance()->post_type();
+			}
+		}
+		$post_tag_row = reset($post_tag_results);
+		$post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
+		if (! $post_tag instanceof EE_Term) {
+			return null;
+		}
 
-        if ($post_tag->post_type === null) {
-            $post_tag->post_type = [];
-        }
-        $post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
-        return $post_tag;
-    }
+		if ($post_tag->post_type === null) {
+			$post_tag->post_type = [];
+		}
+		$post_tag->post_type = array_merge($post_tag->post_type, array_unique($post_types));
+		return $post_tag;
+	}
 
 
-    /**
-     * get_all_event_post_tags
-     *
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_event_post_tags()
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Event.post_type' => EspressoPostType::EVENTS,
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy.Event'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
-            }
-            $post_tags[ $key ]->post_type[] = EspressoPostType::EVENTS;
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_event_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_event_post_tags()
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Event.post_type' => EspressoPostType::EVENTS,
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy.Event'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tags[ $key ]->post_type)) {
+				$post_tags[ $key ]->post_type = [];
+			}
+			$post_tags[ $key ]->post_type[] = EspressoPostType::EVENTS;
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * get_all_venue_post_tags
-     *
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_venue_post_tags()
-    {
-        $post_tags = EEM_Term::instance()->get_all(
-            [
-                [
-                    'Term_Taxonomy.taxonomy'        => 'post_tag',
-                    'Term_Taxonomy.Venue.post_type' => EspressoPostType::VENUES,
-                ],
-                'order_by'   => ['name' => 'ASC'],
-                'force_join' => ['Term_Taxonomy'],
-            ]
-        );
-        foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
-            }
-            $post_tags[ $key ]->post_type[] = EspressoPostType::VENUES;
-        }
-        return $post_tags;
-    }
+	/**
+	 * get_all_venue_post_tags
+	 *
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_venue_post_tags()
+	{
+		$post_tags = EEM_Term::instance()->get_all(
+			[
+				[
+					'Term_Taxonomy.taxonomy'        => 'post_tag',
+					'Term_Taxonomy.Venue.post_type' => EspressoPostType::VENUES,
+				],
+				'order_by'   => ['name' => 'ASC'],
+				'force_join' => ['Term_Taxonomy'],
+			]
+		);
+		foreach ($post_tags as $key => $post_tag) {
+			if (! isset($post_tags[ $key ]->post_type)) {
+				$post_tags[ $key ]->post_type = [];
+			}
+			$post_tags[ $key ]->post_type[] = EspressoPostType::VENUES;
+		}
+		return $post_tags;
+	}
 
 
-    /**
-     * Makes sure that during REST API queries, we only return terms
-     * for term taxonomies which should be shown in the rest api
-     *
-     * @param array    $model_query_params
-     * @param array    $querystring_query_params
-     * @param EEM_Base $model
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
-    {
-        if ($model === EEM_Term::instance()) {
-            $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
-                $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
-            }
-        }
-        return $model_query_params;
-    }
+	/**
+	 * Makes sure that during REST API queries, we only return terms
+	 * for term taxonomies which should be shown in the rest api
+	 *
+	 * @param array    $model_query_params
+	 * @param array    $querystring_query_params
+	 * @param EEM_Base $model
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public static function rest_api_query_params($model_query_params, $querystring_query_params, $model)
+	{
+		if ($model === EEM_Term::instance()) {
+			$taxonomies = get_taxonomies(['show_in_rest' => true]);
+			if (! empty($taxonomies)) {
+				$model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
+			}
+		}
+		return $model_query_params;
+	}
 }

Spacing +26 added lines, -26 removed lines

@@ -40,44 +40,44 @@ 
         ];
         $this->_wp_core_model                                           = true;
         $path_to_tax_model                                              = 'Term_Taxonomy';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       = new EE_Restriction_Generator_Public();
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $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_Taxonomy_Protected(
                 $path_to_tax_model
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       = false;
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     = false;
-        $path_to_tax_model                                              = $path_to_tax_model . '.';
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       = false;
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     = false;
+        $path_to_tax_model                                              = $path_to_tax_model.'.';
         // add cap restrictions for editing relating to the "ee_edit_*"
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_edit_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_edit ]['ee_edit_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_edit]['ee_edit_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_edit_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         // add cap restrictions for deleting relating to the "ee_deleting_*"
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_category' => ['!=', 'espresso_event_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_venue_category'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
+                $path_to_tax_model.'taxonomy*ee_delete_venue_category' => ['!=', 'espresso_venue_categories'],
             ]
         );
-        $this->_cap_restrictions[ EEM_Base::caps_delete ]['ee_delete_event_type']     = new EE_Default_Where_Conditions(
+        $this->_cap_restrictions[EEM_Base::caps_delete]['ee_delete_event_type'] = new EE_Default_Where_Conditions(
             [
-                $path_to_tax_model . 'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
+                $path_to_tax_model.'taxonomy*ee_delete_event_type' => ['!=', 'espresso_event_type'],
             ]
         );
         parent::__construct($timezone);
@@ -171,7 +171,7 @@ 
                 'limit'                    => 2,
             ]
         );
-        if (! $post_tag_results) {
+        if ( ! $post_tag_results) {
             return null;
         }
 
@@ -185,7 +185,7 @@ 
         }
         $post_tag_row = reset($post_tag_results);
         $post_tag     = $this->instantiate_class_from_array_or_object($post_tag_row);
-        if (! $post_tag instanceof EE_Term) {
+        if ( ! $post_tag instanceof EE_Term) {
             return null;
         }
 
@@ -217,10 +217,10 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
+            if ( ! isset($post_tags[$key]->post_type)) {
+                $post_tags[$key]->post_type = [];
             }
-            $post_tags[ $key ]->post_type[] = EspressoPostType::EVENTS;
+            $post_tags[$key]->post_type[] = EspressoPostType::EVENTS;
         }
         return $post_tags;
     }
@@ -246,10 +246,10 @@ 
             ]
         );
         foreach ($post_tags as $key => $post_tag) {
-            if (! isset($post_tags[ $key ]->post_type)) {
-                $post_tags[ $key ]->post_type = [];
+            if ( ! isset($post_tags[$key]->post_type)) {
+                $post_tags[$key]->post_type = [];
             }
-            $post_tags[ $key ]->post_type[] = EspressoPostType::VENUES;
+            $post_tags[$key]->post_type[] = EspressoPostType::VENUES;
         }
         return $post_tags;
     }
@@ -270,7 +270,7 @@ 
     {
         if ($model === EEM_Term::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['Term_Taxonomy.taxonomy'] = ['IN', $taxonomies];
             }
         }