eventespresso / event-espresso-core

core/db_models/EEM_Answer.model.php

Indentation +184 added lines, -184 removed lines

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

Spacing +1 added lines, -1 removed lines

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

core/db_models/EEM_Event_Message_Template.model.php

Indentation +123 added lines, -123 removed lines

@@ -11,138 +11,138 @@
  */
 class EEM_Event_Message_Template extends EEM_Base
 {
-    // private instance of the EEM_Event_Message_Template object
-    protected static $_instance = null;
+	// private instance of the EEM_Event_Message_Template object
+	protected static $_instance = null;
 
 
-    /**
-     * protected constructor to prevent direct creation
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Event Message Template', 'event_espresso');
-        $this->plural_item   = esc_html__('Event Message Templates', 'event_espresso');
+	/**
+	 * protected constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Event Message Template', 'event_espresso');
+		$this->plural_item   = esc_html__('Event Message Templates', 'event_espresso');
 
-        $this->_tables                                                  = [
-            'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
-        ];
-        $this->_fields                                                  = [
-            'Event_Message_Template' => [
-                'EMT_ID' => new EE_Primary_Key_Int_Field(
-                    'EMT_ID',
-                    esc_html__('Event Message Template ID', 'event_espresso')
-                ),
-                'EVT_ID' => new EE_Foreign_Key_Int_Field(
-                    'EVT_ID',
-                    esc_html__('The ID to the Event', 'event_espresso'),
-                    false,
-                    0,
-                    'Event'
-                ),
-                'GRP_ID' => new EE_Foreign_Key_Int_Field(
-                    'GRP_ID',
-                    esc_html__('The ID to the Message Template Group', 'event_espresso'),
-                    false,
-                    0,
-                    'Message_Template_Group'
-                ),
-            ],
-        ];
-        $this->_model_relations                                         = [
-            'Event'                  => new EE_Belongs_To_Relation(),
-            'Message_Template_Group' => new EE_Belongs_To_Relation(),
-        ];
-        $path_to_event                                                  = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
-            new EE_Restriction_Generator_Event_Related_Public(
-                $path_to_event
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event
-            );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Event_Related_Protected(
-                $path_to_event,
-                EEM_Base::caps_edit
-            );
-        parent::__construct($timezone);
-    }
+		$this->_tables                                                  = [
+			'Event_Message_Template' => new EE_Primary_Table('esp_event_message_template', 'EMT_ID'),
+		];
+		$this->_fields                                                  = [
+			'Event_Message_Template' => [
+				'EMT_ID' => new EE_Primary_Key_Int_Field(
+					'EMT_ID',
+					esc_html__('Event Message Template ID', 'event_espresso')
+				),
+				'EVT_ID' => new EE_Foreign_Key_Int_Field(
+					'EVT_ID',
+					esc_html__('The ID to the Event', 'event_espresso'),
+					false,
+					0,
+					'Event'
+				),
+				'GRP_ID' => new EE_Foreign_Key_Int_Field(
+					'GRP_ID',
+					esc_html__('The ID to the Message Template Group', 'event_espresso'),
+					false,
+					0,
+					'Message_Template_Group'
+				),
+			],
+		];
+		$this->_model_relations                                         = [
+			'Event'                  => new EE_Belongs_To_Relation(),
+			'Message_Template_Group' => new EE_Belongs_To_Relation(),
+		];
+		$path_to_event                                                  = 'Event';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+			new EE_Restriction_Generator_Event_Related_Public(
+				$path_to_event
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event
+			);
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Event_Related_Protected(
+				$path_to_event,
+				EEM_Base::caps_edit
+			);
+		parent::__construct($timezone);
+	}
 
 
-    /**
-     * helper method to simply return an array of event ids for events attached to the given
-     * message template group.
-     *
-     * @param int $GRP_ID The MTP group we want attached events for.
-     * @return  array               An array of event ids.
-     * @throws EE_Error
-     * @since 4.3.0
-     */
-    public function get_attached_event_ids($GRP_ID)
-    {
-        $event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
-        $event_ids = call_user_func_array('array_merge', $event_ids);
-        return $event_ids;
-    }
+	/**
+	 * helper method to simply return an array of event ids for events attached to the given
+	 * message template group.
+	 *
+	 * @param int $GRP_ID The MTP group we want attached events for.
+	 * @return  array               An array of event ids.
+	 * @throws EE_Error
+	 * @since 4.3.0
+	 */
+	public function get_attached_event_ids($GRP_ID)
+	{
+		$event_ids = $this->_get_all_wpdb_results([['GRP_ID' => $GRP_ID]], ARRAY_N, 'EVT_ID');
+		$event_ids = call_user_func_array('array_merge', $event_ids);
+		return $event_ids;
+	}
 
 
-    /**
-     * helper method for clearing event/group relations for the given event ids and grp ids.
-     *
-     * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
-     * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
-     * @return int             How many rows were deleted.
-     * @throws EE_Error
-     * @throws EE_Error
-     */
-    public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
-    {
-        if (empty($GRP_IDs) && empty($EVT_IDs)) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        '%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
-                        'event_espresso'
-                    ),
-                    __METHOD__
-                )
-            );
-        }
+	/**
+	 * helper method for clearing event/group relations for the given event ids and grp ids.
+	 *
+	 * @param array $GRP_IDs An array of GRP_IDs. Optional. If empty then there must be EVT IDs.
+	 * @param array $EVT_IDs An array of EVT_IDs.  Optional. If empty then there must be GRP IDs.
+	 * @return int             How many rows were deleted.
+	 * @throws EE_Error
+	 * @throws EE_Error
+	 */
+	public function delete_event_group_relations($GRP_IDs = [], $EVT_IDs = [])
+	{
+		if (empty($GRP_IDs) && empty($EVT_IDs)) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						'%s requires either an array of GRP_IDs or EVT_IDs or both, but both cannot be empty.',
+						'event_espresso'
+					),
+					__METHOD__
+				)
+			);
+		}
 
-        $where = [];
-        if (! empty($GRP_IDs)) {
-            $where['GRP_ID'] = ['IN', (array) $GRP_IDs];
-        }
-        if (! empty($EVT_IDs)) {
-            $where['EVT_ID'] = ['IN', (array) $EVT_IDs];
-        }
+		$where = [];
+		if (! empty($GRP_IDs)) {
+			$where['GRP_ID'] = ['IN', (array) $GRP_IDs];
+		}
+		if (! empty($EVT_IDs)) {
+			$where['EVT_ID'] = ['IN', (array) $EVT_IDs];
+		}
 
-        return $this->delete([$where], false);
-    }
+		return $this->delete([$where], false);
+	}
 
 
-    /**
-     * returns a numerically indexed array
-     * with values that correspond to the 'GRP_ID' column
-     * where the 'EVT_ID' column matches that of the supplied event
-     *
-     * @param EE_Event $event
-     * @return array
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @since   5.0.0.p
-     */
-    public function messageTemplateGroupIDsForEvent(EE_Event $event): array
-    {
-        $results = $this->get_col([['EVT_ID' => $event->ID()]], 'GRP_ID');
-        return $results !== false ? $results : [];
-    }
+	/**
+	 * returns a numerically indexed array
+	 * with values that correspond to the 'GRP_ID' column
+	 * where the 'EVT_ID' column matches that of the supplied event
+	 *
+	 * @param EE_Event $event
+	 * @return array
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @since   5.0.0.p
+	 */
+	public function messageTemplateGroupIDsForEvent(EE_Event $event): array
+	{
+		$results = $this->get_col([['EVT_ID' => $event->ID()]], 'GRP_ID');
+		return $results !== false ? $results : [];
+	}
 }

Spacing +7 added lines, -7 removed lines

@@ -51,24 +51,24 @@ 
                 ),
             ],
         ];
-        $this->_model_relations                                         = [
+        $this->_model_relations = [
             'Event'                  => new EE_Belongs_To_Relation(),
             'Message_Template_Group' => new EE_Belongs_To_Relation(),
         ];
         $path_to_event                                                  = 'Event';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_read]       =
             new EE_Restriction_Generator_Event_Related_Public(
                 $path_to_event
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event
             );
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete] =
             new EE_Restriction_Generator_Event_Related_Protected(
                 $path_to_event,
                 EEM_Base::caps_edit
@@ -118,10 +118,10 @@ 
         }
 
         $where = [];
-        if (! empty($GRP_IDs)) {
+        if ( ! empty($GRP_IDs)) {
             $where['GRP_ID'] = ['IN', (array) $GRP_IDs];
         }
-        if (! empty($EVT_IDs)) {
+        if ( ! empty($EVT_IDs)) {
             $where['EVT_ID'] = ['IN', (array) $EVT_IDs];
         }
 

core/db_models/EEM_Question.model.php

Indentation +572 added lines, -572 removed lines

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

Spacing +11 added lines, -11 removed lines

@@ -132,7 +132,7 @@ 
                 EEM_Question::QST_type_year          => esc_html__('Year', 'event_espresso'),
             ]
         );
-        $this->_question_descriptions         = apply_filters(
+        $this->_question_descriptions = apply_filters(
             'FHEE__EEM_Question__construct__question_descriptions',
             [
                 EEM_Question::QST_type_checkbox      => esc_html__(
@@ -205,7 +205,7 @@ 
                 ),
             ]
         );
-        $this->_question_type_categories      = (array) apply_filters(
+        $this->_question_type_categories = (array) apply_filters(
             'FHEE__EEM_Question__construct__question_type_categories',
             [
                 'text'               => [
@@ -326,13 +326,13 @@ 
             'WP_User'                 => new EE_Belongs_To_Relation(),
         ];
         // this model is generally available for reading
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ]       =
+        $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_admin] =
             new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Reg_Form('QST_system');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Reg_Form('QST_system');
 
         parent::__construct($timezone);
@@ -380,10 +380,10 @@ 
      */
     public function question_type_is_in_category(string $question_type, string $category): bool
     {
-        if (! isset($this->_question_type_categories[ $category ])) {
+        if ( ! isset($this->_question_type_categories[$category])) {
             return false;
         }
-        return in_array($question_type, $this->_question_type_categories[ $category ]);
+        return in_array($question_type, $this->_question_type_categories[$category]);
     }
 
 
@@ -395,8 +395,8 @@ 
      */
     public function question_types_in_category(string $category): array
     {
-        if (isset($this->_question_type_categories[ $category ])) {
-            return $this->_question_type_categories[ $category ];
+        if (isset($this->_question_type_categories[$category])) {
+            return $this->_question_type_categories[$category];
         }
         return [];
     }
@@ -560,7 +560,7 @@ 
     public function absolute_max_for_system_question(string $system_question_value)
     {
         $maxes = $this->system_question_maxes();
-        return $maxes[ $system_question_value ] ?? EE_INF;
+        return $maxes[$system_question_value] ?? EE_INF;
     }
 
 

core/db_models/EEM_Currency.model.php

Indentation +99 added lines, -99 removed lines

@@ -9,110 +9,110 @@
  */
 class EEM_Currency extends EEM_Base
 {
-    // private instance of the Attendee object
-    protected static $_instance = null;
+	// private instance of the Attendee object
+	protected static $_instance = null;
 
 
-    /**
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Currency', 'event_espresso');
-        $this->plural_item      = esc_html__('Currencies', 'event_espresso');
-        $this->_tables          = [
-            'Currency' => new EE_Primary_Table('esp_currency', 'CUR_code'),
-        ];
-        $this->_fields          = [
-            'Currency' => [
-                'CUR_code'    => new EE_Primary_Key_String_Field(
-                    'CUR_code',
-                    esc_html__('Currency Code', 'event_espresso')
-                )
-                ,
-                'CUR_single'  => new EE_Plain_Text_Field(
-                    'CUR_single',
-                    esc_html__('Currency Name Singular', 'event_espresso'),
-                    false
-                ),
-                'CUR_plural'  => new EE_Plain_Text_Field(
-                    'CUR_plural',
-                    esc_html__('Currency Name Plural', 'event_espresso'),
-                    false
-                ),
-                'CUR_sign'    => new EE_Plain_Text_Field(
-                    'CUR_sign',
-                    esc_html__('Currency Sign', 'event_espresso'),
-                    false
-                ),
-                'CUR_dec_plc' => new EE_Integer_Field(
-                    'CUR_dec_plc',
-                    esc_html__('Currency Decimal Places', 'event_espresso'),
-                    false,
-                    2
-                ),
-                'CUR_active'  => new EE_Boolean_Field(
-                    'CUR_active',
-                    esc_html__('Active?', 'event_espresso'),
-                    false,
-                    true
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Payment_Method' => new EE_HABTM_Relation('Currency_Payment_Method'),
-        ];
-        // 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__('Currency', 'event_espresso');
+		$this->plural_item      = esc_html__('Currencies', 'event_espresso');
+		$this->_tables          = [
+			'Currency' => new EE_Primary_Table('esp_currency', 'CUR_code'),
+		];
+		$this->_fields          = [
+			'Currency' => [
+				'CUR_code'    => new EE_Primary_Key_String_Field(
+					'CUR_code',
+					esc_html__('Currency Code', 'event_espresso')
+				)
+				,
+				'CUR_single'  => new EE_Plain_Text_Field(
+					'CUR_single',
+					esc_html__('Currency Name Singular', 'event_espresso'),
+					false
+				),
+				'CUR_plural'  => new EE_Plain_Text_Field(
+					'CUR_plural',
+					esc_html__('Currency Name Plural', 'event_espresso'),
+					false
+				),
+				'CUR_sign'    => new EE_Plain_Text_Field(
+					'CUR_sign',
+					esc_html__('Currency Sign', 'event_espresso'),
+					false
+				),
+				'CUR_dec_plc' => new EE_Integer_Field(
+					'CUR_dec_plc',
+					esc_html__('Currency Decimal Places', 'event_espresso'),
+					false,
+					2
+				),
+				'CUR_active'  => new EE_Boolean_Field(
+					'CUR_active',
+					esc_html__('Active?', 'event_espresso'),
+					false,
+					true
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Payment_Method' => new EE_HABTM_Relation('Currency_Payment_Method'),
+		];
+		// 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);
+	}
 
 
-    /**
-     * Gets all the active currencies, and orders them by their singular name, and then their code
-     * (may be overridden)
-     *
-     * @param array $query_params
-     * @return EE_Currency[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_active($query_params = [])
-    {
-        $query_params[0]['CUR_active'] = true;
-        if (! isset($query_params['order_by'])) {
-            $query_params['order_by'] = ['CUR_code' => 'ASC', 'CUR_single' => 'ASC'];
-        }
-        return $this->get_all($query_params);
-    }
+	/**
+	 * Gets all the active currencies, and orders them by their singular name, and then their code
+	 * (may be overridden)
+	 *
+	 * @param array $query_params
+	 * @return EE_Currency[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_active($query_params = [])
+	{
+		$query_params[0]['CUR_active'] = true;
+		if (! isset($query_params['order_by'])) {
+			$query_params['order_by'] = ['CUR_code' => 'ASC', 'CUR_single' => 'ASC'];
+		}
+		return $this->get_all($query_params);
+	}
 
 
-    /**
-     * Gets all the currencies which can be used by that payment method type
-     *
-     * @param EE_PMT_Base $payment_method_type
-     * @return EE_Currency[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function get_all_currencies_usable_by($payment_method_type)
-    {
-        if (
-            $payment_method_type instanceof EE_PMT_Base
-            && $payment_method_type->get_gateway()
-        ) {
-            $currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
-        } else {
-            $currencies_supported = EE_Gateway::all_currencies_supported;
-        }
-        if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
-            $currencies = $this->get_all_active();
-        } else {
-            $currencies = $this->get_all_active([['CUR_code' => ['IN', $currencies_supported]]]);
-        }
-        return $currencies;
-    }
+	/**
+	 * Gets all the currencies which can be used by that payment method type
+	 *
+	 * @param EE_PMT_Base $payment_method_type
+	 * @return EE_Currency[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function get_all_currencies_usable_by($payment_method_type)
+	{
+		if (
+			$payment_method_type instanceof EE_PMT_Base
+			&& $payment_method_type->get_gateway()
+		) {
+			$currencies_supported = $payment_method_type->get_gateway()->currencies_supported();
+		} else {
+			$currencies_supported = EE_Gateway::all_currencies_supported;
+		}
+		if ($currencies_supported == EE_Gateway::all_currencies_supported || empty($currencies_supported)) {
+			$currencies = $this->get_all_active();
+		} else {
+			$currencies = $this->get_all_active([['CUR_code' => ['IN', $currencies_supported]]]);
+		}
+		return $currencies;
+	}
 }

core/db_models/EEM_Term_Taxonomy.model.php

Indentation +129 added lines, -129 removed lines

@@ -10,139 +10,139 @@
  */
 class EEM_Term_Taxonomy extends EEM_Base
 {
-    /**
-     * @var EEM_Term_Taxonomy
-     */
-    protected static $_instance = null;
+	/**
+	 * @var EEM_Term_Taxonomy
+	 */
+	protected static $_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

Spacing +19 added lines, -19 removed lines

@@ -70,52 +70,52 @@ 
             'Term_Relationship' => new EE_Has_Many_Relation(),
             'Term'              => new EE_Belongs_To_Relation(),
         ];
-        $cpt_models             = array_keys(EE_Registry::instance()->cpt_models());
+        $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->_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 ] =
+        $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;
+        $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(
+        $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);
@@ -137,7 +137,7 @@ 
     {
         if ($model === EEM_Term_Taxonomy::instance()) {
             $taxonomies = get_taxonomies(['show_in_rest' => true]);
-            if (! empty($taxonomies)) {
+            if ( ! empty($taxonomies)) {
                 $model_query_params[0]['taxonomy'] = ['IN', $taxonomies];
             }
         }

core/db_models/relations/EE_HABTM_Any_Relation.php

Indentation +262 added lines, -262 removed lines

@@ -10,291 +10,291 @@
  */
 class EE_HABTM_Any_Relation extends EE_HABTM_Relation
 {
-    protected string $_alphabetically_first_model_name = '';
+	protected string $_alphabetically_first_model_name = '';
 
 
-    /**
-     * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
-     * (and an ee joining-model.) This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool   $block_deletes                  for this type of relation, we block by default for now. if there
-     *                                               are related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct(bool $block_deletes = true, string $blocking_delete_error_message = '')
-    {
-        parent::__construct('Extra_Join', $block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. HasAndBelongsToMany relations always use a join-table
+	 * (and an ee joining-model.) This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool   $block_deletes                  for this type of relation, we block by default for now. if there
+	 *                                               are related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct(bool $block_deletes = true, string $blocking_delete_error_message = '')
+	{
+		parent::__construct('Extra_Join', $block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_alphabetically_first_model_name = min($this_model_name, $other_model_name);
-        parent::_construct_finalize_set_models($this_model_name, $other_model_name);
-    }
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_alphabetically_first_model_name = min($this_model_name, $other_model_name);
+		parent::_construct_finalize_set_models($this_model_name, $other_model_name);
+	}
 
 
-    /**
-     * @param string $model_name
-     * @param string $id_or_name_field should be the string 'ID' or 'name' only
-     * @return EE_Model_Field_Base
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_table_fk_field_to(string $model_name, string $id_or_name_field): EE_Model_Field_Base
-    {
-        $order = $model_name === $this->_alphabetically_first_model_name ? 'first' : 'second';
-        return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
-    }
+	/**
+	 * @param string $model_name
+	 * @param string $id_or_name_field should be the string 'ID' or 'name' only
+	 * @return EE_Model_Field_Base
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_table_fk_field_to(string $model_name, string $id_or_name_field): EE_Model_Field_Base
+	{
+		$order = $model_name === $this->_alphabetically_first_model_name ? 'first' : 'second';
+		return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
-     * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_to_intermediate_model_statement(string $model_relation_chain): string
-    {
-        // create sql like
-        // LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
-        // LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
-        // remember the model relation chain to the JOIN model, because we'll
-        // need it for get_join_statement()
-        $this->_model_relation_chain_to_join_model = $model_relation_chain;
-        $this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();
-        $join_table_fk_field_to_this_table         = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $field_with_model_name                     = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'name'
-        );
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $join_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table                                = $this->get_join_model()->get_table_for_alias($join_table_alias);
-        // phew! ok, we have all the info we need, now we can create the SQL join string
-        return $this->_left_join(
-                $join_table,
-                $join_table_alias,
-                $join_table_fk_field_to_this_table->get_table_column(),
-                $this_table_alias,
-                $this_table_pk_field->get_table_column(),
-                $field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name(
-                ) . "'"
-            ) .
-               $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
-    }
+	/**
+	 * Gets the SQL string for joining the main model's table containing the pk to the join table. Eg "LEFT JOIN
+	 * real_join_table AS join_table_alias ON this_table_alias.pk = join_table_alias.fk_to_this_table"
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_to_intermediate_model_statement(string $model_relation_chain): string
+	{
+		// create sql like
+		// LEFT JOIN join_table AS join_table_alias ON this_table_alias.this_table_pk = join_table_alias.join_table_fk_to_this
+		// LEFT JOIN other_table AS other_table_alias ON join_table_alias.join_table_fk_to_other = other_table_alias.other_table_pk
+		// remember the model relation chain to the JOIN model, because we'll
+		// need it for get_join_statement()
+		$this->_model_relation_chain_to_join_model = $model_relation_chain;
+		$this_table_pk_field                       = $this->get_this_model()->get_primary_key_field();
+		$join_table_fk_field_to_this_table         = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$field_with_model_name                     = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'name'
+		);
+		$this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model()->get_this_model_name()
+			) . $this_table_pk_field->get_table_alias();
+		$join_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_join_model()->get_this_model_name()
+			) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table                                = $this->get_join_model()->get_table_for_alias($join_table_alias);
+		// phew! ok, we have all the info we need, now we can create the SQL join string
+		return $this->_left_join(
+				$join_table,
+				$join_table_alias,
+				$join_table_fk_field_to_this_table->get_table_column(),
+				$this_table_alias,
+				$this_table_pk_field->get_table_column(),
+				$field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name(
+				) . "'"
+			) .
+			   $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
+	}
 
 
-    /**
-     * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
-     * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
-     * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
-     * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
-     * the intermediate join table, and then to the other model's pk's table
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_statement(string $model_relation_chain): string
-    {
-        if (empty($this->_model_relation_chain_to_join_model)) {
-            throw new EE_Error(
-                esc_html__(
-                    'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
-                    'event_espresso'
-                )
-            );
-        }
-        $join_table_fk_field_to_this_table  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_table_fk_field_to_other_table = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $field_with_other_model_name        = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * Gets the SQL string for joining the join table to the other model's pk's table. Eg "LEFT JOIN real_other_table
+	 * AS other_table_alias ON join_table_alias.fk_to_other_table = other_table_alias.pk" If you want to join between
+	 * modelA -> joinModelAB -> modelB (eg, Event -> Event_Question_Group -> Question_Group), you should prepend the
+	 * result of this function with results from get_join_to_intermediate_model_statement(), so that you join first to
+	 * the intermediate join table, and then to the other model's pk's table
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_statement(string $model_relation_chain): string
+	{
+		if (empty($this->_model_relation_chain_to_join_model)) {
+			throw new EE_Error(
+				esc_html__(
+					'When using EE_HABTM_Relation to create a join, you must call get_join_to_intermediate_model_statement BEFORE get_join_statement',
+					'event_espresso'
+				)
+			);
+		}
+		$join_table_fk_field_to_this_table  = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_table_fk_field_to_other_table = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$field_with_other_model_name        = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'name'
+		);
 
-        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $this->_model_relation_chain_to_join_model,
-                $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
+		$join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$this->_model_relation_chain_to_join_model,
+				$this->get_join_model()->get_this_model_name()
+			) . $join_table_fk_field_to_this_table->get_table_alias();
 
-        $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
-        $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+		$other_table_pk_field = $this->get_other_model()->get_primary_key_field();
+		$other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_other_model()->get_this_model_name()
+			) . $other_table_pk_field->get_table_alias();
+		$other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
-        return $this->_left_join(
-                $other_table,
-                $other_table_alias,
-                $other_table_pk_field->get_table_column(),
-                $join_table_alias,
-                $join_table_fk_field_to_other_table->get_table_column(),
-                $field_with_other_model_name->get_qualified_column() . "='" . $this->get_other_model()
-                                                                                   ->get_this_model_name() . "'"
-            ) .
-               $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
-    }
+		return $this->_left_join(
+				$other_table,
+				$other_table_alias,
+				$other_table_pk_field->get_table_column(),
+				$join_table_alias,
+				$join_table_fk_field_to_other_table->get_table_column(),
+				$field_with_other_model_name->get_qualified_column() . "='" . $this->get_other_model()
+																				   ->get_this_model_name() . "'"
+			) .
+			   $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
+	}
 
 
-    /**
-     * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
-     *                                                            checking existing values and for setting new rows if
-     *                                                            no exact matches.
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'name'
-        );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * Ensures there is an entry in the join table between these two models. Feel free to do this manually if you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values col=>val pairs that are used as extra conditions for
+	 *                                                            checking existing values and for setting new rows if
+	 *                                                            no exact matches.
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'name'
+		);
+		$join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'name'
+		);
 
-        $cols_n_values = [
-            $join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
-            $join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
-            $join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
-            $join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
-        ];
+		$cols_n_values = [
+			$join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
+			$join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
+			$join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
+			$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
+		];
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = [];
-            foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($extra_join_model_fields_n_values)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = [];
+			foreach ($extra_join_model_fields_n_values as $query_param => $val) {
+				$query_param                  = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $query_params = [$cols_n_values];
+		$query_params = [$cols_n_values];
 
 
-        $existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
-        // if there is already an entry in the join table, indicating a relationship, we're done
-        // again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
-        // the other tables, use the joining model directly!
-        if (! $existing_entry_in_join_table) {
-            $this->get_join_model()->insert($cols_n_values);
-        }
-        return $other_model_obj;
-    }
+		$existing_entry_in_join_table = $this->get_join_model()->get_one($query_params);
+		// if there is already an entry in the join table, indicating a relationship, we're done
+		// again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
+		// the other tables, use the joining model directly!
+		if (! $existing_entry_in_join_table) {
+			$this->get_join_model()->insert($cols_n_values);
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Deletes any rows in the join table that have foreign keys matching the other model objects specified
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
-     *                                       values and for removing existing rows if exact matches exist.
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // check if such a relationship already exists
-        $join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
-            $this->get_this_model()->get_this_model_name(),
-            'name'
-        );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'ID'
-        );
-        $join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
-            $this->get_other_model()->get_this_model_name(),
-            'name'
-        );
+	/**
+	 * Deletes any rows in the join table that have foreign keys matching the other model objects specified
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query col=>val pairs that are used as extra conditions for checking existing
+	 *                                       values and for removing existing rows if exact matches exist.
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// check if such a relationship already exists
+		$join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+			$this->get_this_model()->get_this_model_name(),
+			'name'
+		);
+		$join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'ID'
+		);
+		$join_model_name_field_to_other_model = $this->get_join_table_fk_field_to(
+			$this->get_other_model()->get_this_model_name(),
+			'name'
+		);
 
-        $cols_n_values = [
-            $join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
-            $join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
-            $join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
-            $join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
-        ];
+		$cols_n_values = [
+			$join_model_fk_to_this_model->get_name()          => $this_model_obj->ID(),
+			$join_model_name_field_to_this_model->get_name()  => $this_model_obj->get_model()->get_this_model_name(),
+			$join_model_fk_to_other_model->get_name()         => $other_model_obj->ID(),
+			$join_model_name_field_to_other_model->get_name() => $other_model_obj->get_model()->get_this_model_name(),
+		];
 
-        // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
-            // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
-            // make sure we strip THIS models name from the query param
-            $parsed_query = [];
-            foreach ($where_query as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
-                    "",
-                    $query_param
-                );
-                $parsed_query[ $query_param ] = $val;
-            }
-            $cols_n_values = array_merge($cols_n_values, $parsed_query);
-        }
+		// if $where_query exists lets add them to the query_params.
+		if (! empty($where_query)) {
+			// make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
+			// make sure we strip THIS models name from the query param
+			$parsed_query = [];
+			foreach ($where_query as $query_param => $val) {
+				$query_param                  = str_replace(
+					$this->get_join_model()->get_this_model_name() . ".",
+					"",
+					$query_param
+				);
+				$parsed_query[ $query_param ] = $val;
+			}
+			$cols_n_values = array_merge($cols_n_values, $parsed_query);
+		}
 
-        $this->get_join_model()->delete([$cols_n_values]);
-        return $other_model_obj;
-    }
+		$this->get_join_model()->delete([$cols_n_values]);
+		return $other_model_obj;
+	}
 }

Spacing +33 added lines, -33 removed lines

@@ -51,7 +51,7 @@ 
     public function get_join_table_fk_field_to(string $model_name, string $id_or_name_field): EE_Model_Field_Base
     {
         $order = $model_name === $this->_alphabetically_first_model_name ? 'first' : 'second';
-        return $this->get_join_model()->field_settings_for('EXJ_' . $order . '_model_' . $id_or_name_field);
+        return $this->get_join_model()->field_settings_for('EXJ_'.$order.'_model_'.$id_or_name_field);
     }
 
 
@@ -77,19 +77,19 @@ 
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $field_with_model_name                     = $this->get_join_table_fk_field_to(
+        $field_with_model_name = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $this_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+        $this_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $join_table_alias                          = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_pk_field->get_table_alias();
+        $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
-        $join_table                                = $this->get_join_model()->get_table_for_alias($join_table_alias);
+            ).$join_table_fk_field_to_this_table->get_table_alias();
+        $join_table = $this->get_join_model()->get_table_for_alias($join_table_alias);
         // phew! ok, we have all the info we need, now we can create the SQL join string
         return $this->_left_join(
                 $join_table,
@@ -97,9 +97,9 @@ 
                 $join_table_fk_field_to_this_table->get_table_column(),
                 $this_table_alias,
                 $this_table_pk_field->get_table_column(),
-                $field_with_model_name->get_qualified_column() . "='" . $this->get_this_model()->get_this_model_name(
-                ) . "'"
-            ) .
+                $field_with_model_name->get_qualified_column()."='".$this->get_this_model()->get_this_model_name(
+                )."'"
+            ).
                $this->get_join_model()->_construct_internal_join_to_table_with_alias($join_table_alias);
     }
 
@@ -126,7 +126,7 @@ 
                 )
             );
         }
-        $join_table_fk_field_to_this_table  = $this->get_join_table_fk_field_to(
+        $join_table_fk_field_to_this_table = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
@@ -134,7 +134,7 @@ 
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
-        $field_with_other_model_name        = $this->get_join_table_fk_field_to(
+        $field_with_other_model_name = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'name'
         );
@@ -142,14 +142,14 @@ 
         $join_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $this->_model_relation_chain_to_join_model,
                 $this->get_join_model()->get_this_model_name()
-            ) . $join_table_fk_field_to_this_table->get_table_alias();
+            ).$join_table_fk_field_to_this_table->get_table_alias();
 
         $other_table_pk_field = $this->get_other_model()->get_primary_key_field();
         $other_table_alias    = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_pk_field->get_table_alias();
-        $other_table          = $this->get_other_model()->get_table_for_alias($other_table_alias);
+            ).$other_table_pk_field->get_table_alias();
+        $other_table = $this->get_other_model()->get_table_for_alias($other_table_alias);
 
         return $this->_left_join(
                 $other_table,
@@ -157,9 +157,9 @@ 
                 $other_table_pk_field->get_table_column(),
                 $join_table_alias,
                 $join_table_fk_field_to_other_table->get_table_column(),
-                $field_with_other_model_name->get_qualified_column() . "='" . $this->get_other_model()
-                                                                                   ->get_this_model_name() . "'"
-            ) .
+                $field_with_other_model_name->get_qualified_column()."='".$this->get_other_model()
+                                                                                   ->get_this_model_name()."'"
+            ).
                $this->get_other_model()->_construct_internal_join_to_table_with_alias($other_table_alias);
     }
 
@@ -184,15 +184,15 @@ 
         $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
         $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
         // check if such a relationship already exists
-        $join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+        $join_model_name_field_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_other_model = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
@@ -209,17 +209,17 @@ 
         ];
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($extra_join_model_fields_n_values)) {
+        if ( ! empty($extra_join_model_fields_n_values)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = [];
             foreach ($extra_join_model_fields_n_values as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $cols_n_values = array_merge($cols_n_values, $parsed_query);
         }
@@ -231,7 +231,7 @@ 
         // if there is already an entry in the join table, indicating a relationship, we're done
         // again, if you want more sophisticated logic or insertions (handling more columns than just 2 foreign keys to
         // the other tables, use the joining model directly!
-        if (! $existing_entry_in_join_table) {
+        if ( ! $existing_entry_in_join_table) {
             $this->get_join_model()->insert($cols_n_values);
         }
         return $other_model_obj;
@@ -254,15 +254,15 @@ 
         $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
         $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
         // check if such a relationship already exists
-        $join_model_fk_to_this_model          = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'ID'
         );
-        $join_model_name_field_to_this_model  = $this->get_join_table_fk_field_to(
+        $join_model_name_field_to_this_model = $this->get_join_table_fk_field_to(
             $this->get_this_model()->get_this_model_name(),
             'name'
         );
-        $join_model_fk_to_other_model         = $this->get_join_table_fk_field_to(
+        $join_model_fk_to_other_model = $this->get_join_table_fk_field_to(
             $this->get_other_model()->get_this_model_name(),
             'ID'
         );
@@ -279,17 +279,17 @@ 
         ];
 
         // if $where_query exists lets add them to the query_params.
-        if (! empty($where_query)) {
+        if ( ! empty($where_query)) {
             // make sure we strip any of the join model names from the $where_query cause we don't need that in here (why? because client code may have used the same conditionals for get_all_related which DOES need the join model name)
             // make sure we strip THIS models name from the query param
             $parsed_query = [];
             foreach ($where_query as $query_param => $val) {
-                $query_param                  = str_replace(
-                    $this->get_join_model()->get_this_model_name() . ".",
+                $query_param = str_replace(
+                    $this->get_join_model()->get_this_model_name().".",
                     "",
                     $query_param
                 );
-                $parsed_query[ $query_param ] = $val;
+                $parsed_query[$query_param] = $val;
             }
             $cols_n_values = array_merge($cols_n_values, $parsed_query);
         }

core/db_models/relations/EE_Has_Many_Any_Relation.php

Indentation +96 added lines, -96 removed lines

@@ -14,106 +14,106 @@
  */
 class EE_Has_Many_Any_Relation extends EE_Has_Many_Relation
 {
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                                     other_model_primary_table.fk" etc
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_statement(string $model_relation_chain): string
-    {
-        // create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field   = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field  =
-            $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_other_model()->get_this_model_name()
-            ) . $other_table_fk_field->get_table_alias();
-        $fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
-        $field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                                     other_model_primary_table.fk" etc
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_statement(string $model_relation_chain): string
+	{
+		// create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field   = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field  =
+			$this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model()->get_this_model_name()
+			) . $this_table_pk_field->get_table_alias();
+		$fk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_other_model()->get_this_model_name()
+			) . $other_table_fk_field->get_table_alias();
+		$fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+		$field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
 
-        return $this->_left_join(
-                $fk_table,
-                $fk_table_alias,
-                $other_table_fk_field->get_table_column(),
-                $pk_table_alias,
-                $this_table_pk_field->get_table_column(),
-                $fk_table_alias . '.' . $field_with_model_name->get_table_column()
-                . "='" . $this->get_this_model()->get_this_model_name() . "'"
-            )
-               . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join(
+				$fk_table,
+				$fk_table_alias,
+				$other_table_fk_field->get_table_column(),
+				$pk_table_alias,
+				$this_table_pk_field->get_table_column(),
+				$fk_table_alias . '.' . $field_with_model_name->get_table_column()
+				. "='" . $this->get_this_model()->get_this_model_name() . "'"
+			)
+			   . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+	/**
+	 * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
-            $this->get_this_model()->get_this_model_name()
-        );
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-        $other_model_obj->set(
-            $this->get_other_model()->get_field_containing_related_model_name()->get_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
+			$this->get_this_model()->get_this_model_name()
+		);
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+		$other_model_obj->set(
+			$this->get_other_model()->get_field_containing_related_model_name()->get_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
-            $this->get_this_model()->get_this_model_name()
-        );
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->set(
-            $this->get_other_model()->get_field_containing_related_model_name()->get_name(),
-            null,
-            true
-        );
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
+			$this->get_this_model()->get_this_model_name()
+		);
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->set(
+			$this->get_other_model()->get_field_containing_related_model_name()->get_name(),
+			null,
+			true
+		);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -33,11 +33,11 @@ 
         $pk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias        = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_pk_field->get_table_alias();
+        $fk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_fk_field->get_table_alias();
+            ).$other_table_fk_field->get_table_alias();
         $fk_table              = $this->get_other_model()->get_table_for_alias($fk_table_alias);
         $field_with_model_name = $this->get_other_model()->get_field_containing_related_model_name();
 
@@ -47,8 +47,8 @@ 
                 $other_table_fk_field->get_table_column(),
                 $pk_table_alias,
                 $this_table_pk_field->get_table_column(),
-                $fk_table_alias . '.' . $field_with_model_name->get_table_column()
-                . "='" . $this->get_this_model()->get_this_model_name() . "'"
+                $fk_table_alias.'.'.$field_with_model_name->get_table_column()
+                . "='".$this->get_this_model()->get_this_model_name()."'"
             )
                . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
     }

core/db_models/relations/EE_Has_Many_Relation.php

Indentation +101 added lines, -101 removed lines

@@ -10,113 +10,113 @@
  */
 class EE_Has_Many_Relation extends EE_Model_Relation_Base
 {
-    /**
-     * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
-     * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
-     * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
-     * related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool   $block_deletes                  For this type of r elation, we block by default. If there are
-     *                                               related models across this relation, block (prevent and add an
-     *                                               error) the deletion of this model
-     * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct(bool $block_deletes = true, string $blocking_delete_error_message = '')
-    {
-        parent::__construct($block_deletes, $blocking_delete_error_message);
-    }
+	/**
+	 * Object representing the relationship between two models. Has_Many_Relations are where the OTHER model has the
+	 * foreign key this model. IE, there can be many other model objects related to one of this model's objects (but
+	 * NOT through a JOIN table, which is the case for EE_HABTM_Relations). This knows how to join the models, get
+	 * related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool   $block_deletes                  For this type of r elation, we block by default. If there are
+	 *                                               related models across this relation, block (prevent and add an
+	 *                                               error) the deletion of this model
+	 * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct(bool $block_deletes = true, string $blocking_delete_error_message = '')
+	{
+		parent::__construct($block_deletes, $blocking_delete_error_message);
+	}
 
 
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                                     other_model_primary_table.fk" etc
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function get_join_statement(string $model_relation_chain): string
-    {
-        // create the sql string like
-        // LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
-        $this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
-        $other_table_fk_field =
-            $this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
-        $pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
-                $model_relation_chain,
-                $this->get_other_model()->get_this_model_name()
-            ) . $other_table_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                                     other_model_primary_table.fk" etc
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function get_join_statement(string $model_relation_chain): string
+	{
+		// create the sql string like
+		// LEFT JOIN other_table AS table_alias ON this_table_alias.pk = other_table_alias.fk extra_join_conditions
+		$this_table_pk_field  = $this->get_this_model()->get_primary_key_field();
+		$other_table_fk_field =
+			$this->get_other_model()->get_foreign_key_to($this->get_this_model()->get_this_model_name());
+		$pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_this_model()->get_this_model_name()
+			) . $this_table_pk_field->get_table_alias();
+		$fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+				$model_relation_chain,
+				$this->get_other_model()->get_this_model_name()
+			) . $other_table_fk_field->get_table_alias();
+		$fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
-        return $this->_left_join(
-                $fk_table,
-                $fk_table_alias,
-                $other_table_fk_field->get_table_column(),
-                $pk_table_alias,
-                $this_table_pk_field->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
-    }
+		return $this->_left_join(
+				$fk_table,
+				$fk_table_alias,
+				$other_table_fk_field->get_table_column(),
+				$pk_table_alias,
+				$this_table_pk_field->get_table_column()
+			) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
-     * you like.
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $extra_join_model_fields_n_values
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class {
-        $this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+	/**
+	 * Sets the other model object's foreign key to this model object's primary key. Feel free to do this manually if
+	 * you like.
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $extra_join_model_fields_n_values
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class {
+		$this_model_obj  = $this->get_this_model()->ensure_is_obj($this_obj_or_id, true);
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
 
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
-            $this->get_this_model()->get_this_model_name()
-        );
-        if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
-            // set that field on the other model to this model's ID
-            $other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
-            $other_model_obj->save();
-        }
-        return $other_model_obj;
-    }
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
+			$this->get_this_model()->get_this_model_name()
+		);
+		if ($other_model_obj->get($fk_field_on_other_model->get_name()) != $this_model_obj->ID()) {
+			// set that field on the other model to this model's ID
+			$other_model_obj->set($fk_field_on_other_model->get_name(), $this_model_obj->ID());
+			$other_model_obj->save();
+		}
+		return $other_model_obj;
+	}
 
 
-    /**
-     * Sets the other model object's foreign key to its default, instead of pointing to this model object.
-     * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
-     *
-     * @param EE_Base_Class|int $this_obj_or_id
-     * @param EE_Base_Class|int $other_obj_or_id
-     * @param array             $where_query
-     * @return EE_Base_Class
-     * @throws EE_Error
-     * @throws Exception
-     */
-    public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
-    {
-        $other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
-        // find the field on the other model which is a foreign key to this model
-        $fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
-            $this->get_this_model()->get_this_model_name()
-        );
-        // set that field on the other model to this model's ID
-        $other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
-        $other_model_obj->save();
-        return $other_model_obj;
-    }
+	/**
+	 * Sets the other model object's foreign key to its default, instead of pointing to this model object.
+	 * If $other_obj_or_id doesn't have any other relations, this function is essentially orphaning it
+	 *
+	 * @param EE_Base_Class|int $this_obj_or_id
+	 * @param EE_Base_Class|int $other_obj_or_id
+	 * @param array             $where_query
+	 * @return EE_Base_Class
+	 * @throws EE_Error
+	 * @throws Exception
+	 */
+	public function remove_relation_to($this_obj_or_id, $other_obj_or_id, array $where_query = []): EE_Base_Class
+	{
+		$other_model_obj = $this->get_other_model()->ensure_is_obj($other_obj_or_id, true);
+		// find the field on the other model which is a foreign key to this model
+		$fk_field_on_other_model = $this->get_other_model()->get_foreign_key_to(
+			$this->get_this_model()->get_this_model_name()
+		);
+		// set that field on the other model to this model's ID
+		$other_model_obj->set($fk_field_on_other_model->get_name(), null, true);
+		$other_model_obj->save();
+		return $other_model_obj;
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -47,12 +47,12 @@ 
         $pk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_this_model()->get_this_model_name()
-            ) . $this_table_pk_field->get_table_alias();
-        $fk_table_alias       = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
+            ).$this_table_pk_field->get_table_alias();
+        $fk_table_alias = EE_Model_Parser::extract_table_alias_model_relation_chain_prefix(
                 $model_relation_chain,
                 $this->get_other_model()->get_this_model_name()
-            ) . $other_table_fk_field->get_table_alias();
-        $fk_table             = $this->get_other_model()->get_table_for_alias($fk_table_alias);
+            ).$other_table_fk_field->get_table_alias();
+        $fk_table = $this->get_other_model()->get_table_for_alias($fk_table_alias);
 
         return $this->_left_join(
                 $fk_table,
@@ -60,7 +60,7 @@ 
                 $other_table_fk_field->get_table_column(),
                 $pk_table_alias,
                 $this_table_pk_field->get_table_column()
-            ) . $this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
+            ).$this->get_other_model()->_construct_internal_join_to_table_with_alias($fk_table_alias);
     }
 
 

core/db_models/relations/EE_Model_Relation_Base.php

Indentation +524 added lines, -524 removed lines

@@ -16,531 +16,531 @@
  */
 abstract class EE_Model_Relation_Base implements HasSchemaInterface
 {
-    /**
-     * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private string $_this_model_name = '';
-
-    /**
-     * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
-     *
-     * @var string eg Event, Question_Group, Registration
-     */
-    private string $_other_model_name = '';
-
-    /**
-     * this is typically used when calling the relation models to make sure they inherit any set timezone from the
-     * initiating model.
-     *
-     * @var string
-     */
-    protected string $_timezone = '';
-
-    /**
-     * If you try to delete "this_model", and there are related "other_models",
-     * and this isn't null, then abandon the deletion and add this warning.
-     * This effectively makes it impossible to delete "this_model" while there are
-     * related "other_models" along this relation.
-     *
-     * @var string (internationalized)
-     */
-    protected string $_blocking_delete_error_message;
-
-    protected bool   $_blocking_delete = false;
-
-
-    /**
-     * Object representing the relationship between two models. This knows how to join the models,
-     * get related models across the relation, and add-and-remove the relationships.
-     *
-     * @param bool   $block_deletes                  if there are related models across this relation, block (prevent
-     *                                               and add an error) the deletion of this model
-     * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
-     *                                               default
-     */
-    public function __construct(bool $block_deletes = false, string $blocking_delete_error_message = '')
-    {
-        $this->_blocking_delete               = filter_var($block_deletes, FILTER_VALIDATE_BOOLEAN);
-        $this->_blocking_delete_error_message = $blocking_delete_error_message;
-    }
-
-
-    /**
-     * @param $this_model_name
-     * @param $other_model_name
-     */
-    public function _construct_finalize_set_models($this_model_name, $other_model_name)
-    {
-        $this->_this_model_name  = $this_model_name;
-        $this->_other_model_name = $other_model_name;
-    }
-
-
-    /**
-     * Gets the model where this relation is defined.
-     *
-     * @return EEM_Base
-     * @throws Exception
-     */
-    public function get_this_model(): EEM_Base
-    {
-        return $this->_get_model($this->_this_model_name);
-    }
-
-
-    /**
-     * Gets the model which this relation establishes the relation TO (ie,
-     * this relation object was defined on get_this_model(), get_other_model() is the other one)
-     *
-     * @return EEM_Base
-     * @throws Exception
-     */
-    public function get_other_model(): EEM_Base
-    {
-        return $this->_get_model($this->_other_model_name);
-    }
-
-
-    /**
-     * Internally used by get_this_model() and get_other_model()
-     *
-     * @param string $model_name like Event, Question_Group, etc. omit the EEM_
-     * @return EEM_Base
-     * @throws Exception
-     */
-    protected function _get_model(string $model_name): EEM_Base
-    {
-        /** @var EEM_Base $modelInstance */
-        $modelInstance = EE_Registry::instance()->load_model($model_name);
-        $modelInstance->set_timezone($this->_timezone);
-        return $modelInstance;
-    }
-
-
-    /**
-     * entirely possible that relations may be called from a model and we need to make sure those relations have their
-     * timezone set correctly.
-     *
-     * @param string|null $timezone timezone to set.
-     */
-    public function set_timezone(?string $timezone = '')
-    {
-        if ($timezone) {
-            $this->_timezone = $timezone;
-        }
-    }
-
-
-    /**
-     * @param string $other_table
-     * @param string $other_table_alias
-     * @param string $other_table_column
-     * @param string $this_table_alias
-     * @param string $this_table_join_column
-     * @param string $extra_join_sql
-     * @return string
-     */
-    protected function _left_join(
-        string $other_table,
-        string $other_table_alias,
-        string $other_table_column,
-        string $this_table_alias,
-        string $this_table_join_column,
-        string $extra_join_sql = ''
-    ): string {
-        return " 
+	/**
+	 * The model name of which this relation is a component (ie, the model that called new EE_Model_Relation_Base)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private string $_this_model_name = '';
+
+	/**
+	 * The model name pointed to by this relation (ie, the model we want to establish a relationship to)
+	 *
+	 * @var string eg Event, Question_Group, Registration
+	 */
+	private string $_other_model_name = '';
+
+	/**
+	 * this is typically used when calling the relation models to make sure they inherit any set timezone from the
+	 * initiating model.
+	 *
+	 * @var string
+	 */
+	protected string $_timezone = '';
+
+	/**
+	 * If you try to delete "this_model", and there are related "other_models",
+	 * and this isn't null, then abandon the deletion and add this warning.
+	 * This effectively makes it impossible to delete "this_model" while there are
+	 * related "other_models" along this relation.
+	 *
+	 * @var string (internationalized)
+	 */
+	protected string $_blocking_delete_error_message;
+
+	protected bool   $_blocking_delete = false;
+
+
+	/**
+	 * Object representing the relationship between two models. This knows how to join the models,
+	 * get related models across the relation, and add-and-remove the relationships.
+	 *
+	 * @param bool   $block_deletes                  if there are related models across this relation, block (prevent
+	 *                                               and add an error) the deletion of this model
+	 * @param string $blocking_delete_error_message  a customized error message on blocking deletes instead of the
+	 *                                               default
+	 */
+	public function __construct(bool $block_deletes = false, string $blocking_delete_error_message = '')
+	{
+		$this->_blocking_delete               = filter_var($block_deletes, FILTER_VALIDATE_BOOLEAN);
+		$this->_blocking_delete_error_message = $blocking_delete_error_message;
+	}
+
+
+	/**
+	 * @param $this_model_name
+	 * @param $other_model_name
+	 */
+	public function _construct_finalize_set_models($this_model_name, $other_model_name)
+	{
+		$this->_this_model_name  = $this_model_name;
+		$this->_other_model_name = $other_model_name;
+	}
+
+
+	/**
+	 * Gets the model where this relation is defined.
+	 *
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	public function get_this_model(): EEM_Base
+	{
+		return $this->_get_model($this->_this_model_name);
+	}
+
+
+	/**
+	 * Gets the model which this relation establishes the relation TO (ie,
+	 * this relation object was defined on get_this_model(), get_other_model() is the other one)
+	 *
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	public function get_other_model(): EEM_Base
+	{
+		return $this->_get_model($this->_other_model_name);
+	}
+
+
+	/**
+	 * Internally used by get_this_model() and get_other_model()
+	 *
+	 * @param string $model_name like Event, Question_Group, etc. omit the EEM_
+	 * @return EEM_Base
+	 * @throws Exception
+	 */
+	protected function _get_model(string $model_name): EEM_Base
+	{
+		/** @var EEM_Base $modelInstance */
+		$modelInstance = EE_Registry::instance()->load_model($model_name);
+		$modelInstance->set_timezone($this->_timezone);
+		return $modelInstance;
+	}
+
+
+	/**
+	 * entirely possible that relations may be called from a model and we need to make sure those relations have their
+	 * timezone set correctly.
+	 *
+	 * @param string|null $timezone timezone to set.
+	 */
+	public function set_timezone(?string $timezone = '')
+	{
+		if ($timezone) {
+			$this->_timezone = $timezone;
+		}
+	}
+
+
+	/**
+	 * @param string $other_table
+	 * @param string $other_table_alias
+	 * @param string $other_table_column
+	 * @param string $this_table_alias
+	 * @param string $this_table_join_column
+	 * @param string $extra_join_sql
+	 * @return string
+	 */
+	protected function _left_join(
+		string $other_table,
+		string $other_table_alias,
+		string $other_table_column,
+		string $this_table_alias,
+		string $this_table_join_column,
+		string $extra_join_sql = ''
+	): string {
+		return " 
         LEFT JOIN " . $other_table . " AS " . $other_table_alias . " 
         ON " . $other_table_alias . "." . $other_table_column
-               . "=" . $this_table_alias . "." . $this_table_join_column
-               . ($extra_join_sql ? " AND $extra_join_sql" : '');
-    }
-
-
-    /**
-     * Gets all the model objects of type of other model related to $model_object,
-     * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
-     * For both of those child classes, $model_object must be saved so that it has an ID before querying,
-     * otherwise an error will be thrown. Note: by default we disable default_where_conditions
-     * EE_Belongs_To_Relation doesn't need to be saved before querying.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id                      or the primary key of this model
-     * @param array|null               $query_params
-     * @param boolean                  $values_already_prepared_by_model_object @deprecated 4.8.1
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_all_related(
-        $model_object_or_id,
-        ?array $query_params = [],
-        bool $values_already_prepared_by_model_object = false
-    ): array {
-        if ($values_already_prepared_by_model_object !== false) {
-            EE_Error::doing_it_wrong(
-                'EE_Model_Relation_Base::get_all_related',
-                esc_html__(
-                    'The argument $values_already_prepared_by_model_object is no longer used.',
-                    'event_espresso'
-                ),
-                '4.8.1'
-            );
-        }
-        $query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
-
-        $query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
-                                           . "." . $this->get_this_model()->get_primary_key_field()->get_name();
-
-        $model_object_id = $this->_get_model_object_id($model_object_or_id);
-
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
-        return $this->get_other_model()->get_all($query_params);
-    }
-
-
-    /**
-     * Alters the $query_params to disable default where conditions, unless otherwise specified
-     *
-     * @param array $query_params
-     * @return array
-     */
-    protected function _disable_default_where_conditions_on_query_param(array $query_params): array
-    {
-        if (! isset($query_params['default_where_conditions'])) {
-            $query_params['default_where_conditions'] = 'none';
-        }
-        return $query_params;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function delete_all_related($model_object_or_id, array $query_params = []): int
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $related_model_object->delete();
-                $deleted_count++;
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * Deletes the related model objects which meet the query parameters. If no
-     * parameters are specified, then all related model objects will be deleted.
-     * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
-     * model objects will only be soft-deleted.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id
-     * @param array                    $query_params
-     * @return int of how many related models got deleted
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    public function delete_related_permanently($model_object_or_id, array $query_params = []): int
-    {
-        // for each thing we would delete,
-        $related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
-        // determine if it's blocked by anything else before it can be deleted
-        $deleted_count = 0;
-        foreach ($related_model_objects as $related_model_object) {
-            $delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
-                $related_model_object,
-                $model_object_or_id
-            );
-            /* @var $model_object_or_id EE_Base_Class */
-            if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
-                $this->remove_relation_to($model_object_or_id, $related_model_object);
-                $deleted_count++;
-                if (! $delete_is_blocked) {
-                    $related_model_object->delete_permanently();
-                } else {
-                    // delete is blocked
-                    // brent and darren, in this case, wanted to just soft delete it then
-                    $related_model_object->delete();
-                }
-            } else {
-                // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
-                    $this->remove_relation_to($model_object_or_id, $related_model_object);
-                    $related_model_object->delete();
-                    $deleted_count++;
-                }
-            }
-        }
-        return $deleted_count;
-    }
-
-
-    /**
-     * this just returns a model_object_id for incoming item that could be an object or id.
-     *
-     * @param EE_Base_Class|int|string $model_object_or_id model object or the primary key of this model
-     * @return int
-     * @throws EE_Error
-     * @throws ReflectionException
-     * @throws Exception
-     */
-    protected function _get_model_object_id($model_object_or_id)
-    {
-        $model_object_id = $model_object_or_id;
-        if ($model_object_or_id instanceof EE_Base_Class) {
-            $model_object_id = $model_object_or_id->ID();
-        }
-        if (! $model_object_id) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
-                        "event_espresso"
-                    ),
-                    $this->get_other_model()->get_this_model_name(),
-                    $this->get_this_model()->get_this_model_name()
-                )
-            );
-        }
-        return $model_object_id;
-    }
-
-
-    /**
-     * Gets the SQL string for performing the join between this model and the other model.
-     *
-     * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
-     * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
-     *                                     other_model_primary_table.fk" etc
-     */
-    abstract public function get_join_statement(string $model_relation_chain): string;
-
-
-    /**
-     * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
-     * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
-     * relationship only allows this model to be related to a single other model of this type)
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param EE_Base_Class|int|string $other_obj_or_id
-     * @param array                    $extra_join_model_fields_n_values
-     * @return EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
-     *                        $other_obj_or_id)
-     */
-    abstract public function add_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $extra_join_model_fields_n_values = []
-    ): EE_Base_Class;
-
-
-    /**
-     * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
-     * model objects
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param EE_Base_Class|int|string $other_obj_or_id
-     * @param array                    $where_query
-     * @return EE_Base_Class
-     */
-    abstract public function remove_relation_to(
-        $this_obj_or_id,
-        $other_obj_or_id,
-        array $where_query = []
-    ): EE_Base_Class;
-
-
-    /**
-     * Removes ALL relation instances for this relation obj
-     *
-     * @param EE_Base_Class|int|string $this_obj_or_id
-     * @param array                    $where_query_param @see
-     *                                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
-     * @return EE_Base_Class[]
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function remove_relations($this_obj_or_id, array $where_query_param = []): array
-    {
-        $related_things = $this->get_all_related($this_obj_or_id, [$where_query_param]);
-        $objs_removed   = [];
-        foreach ($related_things as $related_thing) {
-            $objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
-        }
-        return $objs_removed;
-    }
-
-
-    /**
-     * If you aren't allowed to delete this model when there are related models across this
-     * relation object, return true. Otherwise, if you can delete this model even though
-     * related objects exist, returns false.
-     *
-     * @return boolean
-     */
-    public function block_delete_if_related_models_exist(): bool
-    {
-        return $this->_blocking_delete;
-    }
-
-
-    /**
-     * Gets the error message to show
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function get_deletion_error_message(): string
-    {
-        if ($this->_blocking_delete_error_message) {
-            return $this->_blocking_delete_error_message;
-        } else {
+			   . "=" . $this_table_alias . "." . $this_table_join_column
+			   . ($extra_join_sql ? " AND $extra_join_sql" : '');
+	}
+
+
+	/**
+	 * Gets all the model objects of type of other model related to $model_object,
+	 * according to this relation. This is the same code for EE_HABTM_Relation and EE_Has_Many_Relation.
+	 * For both of those child classes, $model_object must be saved so that it has an ID before querying,
+	 * otherwise an error will be thrown. Note: by default we disable default_where_conditions
+	 * EE_Belongs_To_Relation doesn't need to be saved before querying.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id                      or the primary key of this model
+	 * @param array|null               $query_params
+	 * @param boolean                  $values_already_prepared_by_model_object @deprecated 4.8.1
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_all_related(
+		$model_object_or_id,
+		?array $query_params = [],
+		bool $values_already_prepared_by_model_object = false
+	): array {
+		if ($values_already_prepared_by_model_object !== false) {
+			EE_Error::doing_it_wrong(
+				'EE_Model_Relation_Base::get_all_related',
+				esc_html__(
+					'The argument $values_already_prepared_by_model_object is no longer used.',
+					'event_espresso'
+				),
+				'4.8.1'
+			);
+		}
+		$query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
+
+		$query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
+										   . "." . $this->get_this_model()->get_primary_key_field()->get_name();
+
+		$model_object_id = $this->_get_model_object_id($model_object_or_id);
+
+		$query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+		return $this->get_other_model()->get_all($query_params);
+	}
+
+
+	/**
+	 * Alters the $query_params to disable default where conditions, unless otherwise specified
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	protected function _disable_default_where_conditions_on_query_param(array $query_params): array
+	{
+		if (! isset($query_params['default_where_conditions'])) {
+			$query_params['default_where_conditions'] = 'none';
+		}
+		return $query_params;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function delete_all_related($model_object_or_id, array $query_params = []): int
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if (! $delete_is_blocked) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$related_model_object->delete();
+				$deleted_count++;
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * Deletes the related model objects which meet the query parameters. If no
+	 * parameters are specified, then all related model objects will be deleted.
+	 * Note: If the related model is extends EEM_Soft_Delete_Base, then the related
+	 * model objects will only be soft-deleted.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id
+	 * @param array                    $query_params
+	 * @return int of how many related models got deleted
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	public function delete_related_permanently($model_object_or_id, array $query_params = []): int
+	{
+		// for each thing we would delete,
+		$related_model_objects = $this->get_all_related($model_object_or_id, $query_params);
+		// determine if it's blocked by anything else before it can be deleted
+		$deleted_count = 0;
+		foreach ($related_model_objects as $related_model_object) {
+			$delete_is_blocked = $this->get_other_model()->delete_is_blocked_by_related_models(
+				$related_model_object,
+				$model_object_or_id
+			);
+			/* @var $model_object_or_id EE_Base_Class */
+			if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
+				$this->remove_relation_to($model_object_or_id, $related_model_object);
+				$deleted_count++;
+				if (! $delete_is_blocked) {
+					$related_model_object->delete_permanently();
+				} else {
+					// delete is blocked
+					// brent and darren, in this case, wanted to just soft delete it then
+					$related_model_object->delete();
+				}
+			} else {
+				// its not a soft-deletable thing anyways. do the normal logic.
+				if (! $delete_is_blocked) {
+					$this->remove_relation_to($model_object_or_id, $related_model_object);
+					$related_model_object->delete();
+					$deleted_count++;
+				}
+			}
+		}
+		return $deleted_count;
+	}
+
+
+	/**
+	 * this just returns a model_object_id for incoming item that could be an object or id.
+	 *
+	 * @param EE_Base_Class|int|string $model_object_or_id model object or the primary key of this model
+	 * @return int
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 * @throws Exception
+	 */
+	protected function _get_model_object_id($model_object_or_id)
+	{
+		$model_object_id = $model_object_or_id;
+		if ($model_object_or_id instanceof EE_Base_Class) {
+			$model_object_id = $model_object_or_id->ID();
+		}
+		if (! $model_object_id) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Sorry, we cant get the related %s model objects to %s model object before it has an ID. You can solve that by just saving it before trying to get its related model objects",
+						"event_espresso"
+					),
+					$this->get_other_model()->get_this_model_name(),
+					$this->get_this_model()->get_this_model_name()
+				)
+			);
+		}
+		return $model_object_id;
+	}
+
+
+	/**
+	 * Gets the SQL string for performing the join between this model and the other model.
+	 *
+	 * @param string $model_relation_chain like 'Event.Event_Venue.Venue'
+	 * @return string of SQL, eg "LEFT JOIN table_name AS table_alias ON this_model_primary_table.pk =
+	 *                                     other_model_primary_table.fk" etc
+	 */
+	abstract public function get_join_statement(string $model_relation_chain): string;
+
+
+	/**
+	 * Adds a relationships between the two model objects provided. Each type of relationship handles this differently
+	 * (EE_Belongs_To is a slight exception, it should more accurately be called set_relation_to(...), as this
+	 * relationship only allows this model to be related to a single other model of this type)
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param EE_Base_Class|int|string $other_obj_or_id
+	 * @param array                    $extra_join_model_fields_n_values
+	 * @return EE_Base_Class the EE_Base_Class which was added as a relation. (Convenient if you only pass an ID for
+	 *                        $other_obj_or_id)
+	 */
+	abstract public function add_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $extra_join_model_fields_n_values = []
+	): EE_Base_Class;
+
+
+	/**
+	 * Similar to 'add_relation_to(...)', performs the opposite action of removing the relationship between the two
+	 * model objects
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param EE_Base_Class|int|string $other_obj_or_id
+	 * @param array                    $where_query
+	 * @return EE_Base_Class
+	 */
+	abstract public function remove_relation_to(
+		$this_obj_or_id,
+		$other_obj_or_id,
+		array $where_query = []
+	): EE_Base_Class;
+
+
+	/**
+	 * Removes ALL relation instances for this relation obj
+	 *
+	 * @param EE_Base_Class|int|string $this_obj_or_id
+	 * @param array                    $where_query_param @see
+	 *                                                    https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md#0-where-conditions
+	 * @return EE_Base_Class[]
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function remove_relations($this_obj_or_id, array $where_query_param = []): array
+	{
+		$related_things = $this->get_all_related($this_obj_or_id, [$where_query_param]);
+		$objs_removed   = [];
+		foreach ($related_things as $related_thing) {
+			$objs_removed[] = $this->remove_relation_to($this_obj_or_id, $related_thing);
+		}
+		return $objs_removed;
+	}
+
+
+	/**
+	 * If you aren't allowed to delete this model when there are related models across this
+	 * relation object, return true. Otherwise, if you can delete this model even though
+	 * related objects exist, returns false.
+	 *
+	 * @return boolean
+	 */
+	public function block_delete_if_related_models_exist(): bool
+	{
+		return $this->_blocking_delete;
+	}
+
+
+	/**
+	 * Gets the error message to show
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function get_deletion_error_message(): string
+	{
+		if ($this->_blocking_delete_error_message) {
+			return $this->_blocking_delete_error_message;
+		} else {
 //          return sprintf(esc_html__('Cannot delete %1$s when there are related %2$s', "event_espresso"),$this->get_this_model()->item_name(2),$this->get_other_model()->item_name(2));
-            return sprintf(
-                esc_html__(
-                    'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
-                    "event_espresso"
-                ),
-                $this->get_this_model()->item_name(),
-                $this->get_other_model()->item_name(),
-                $this->get_other_model()->item_name(2)
-            );
-        }
-    }
-
-
-    /**
-     * Returns whatever is set as the nicename for the object.
-     *
-     * @return string
-     * @throws Exception
-     */
-    public function getSchemaDescription(): string
-    {
-        $description = $this instanceof EE_Belongs_To_Relation
-            ? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
-            : esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
-        return sprintf(
-            $description,
-            $this->get_other_model()->get_this_model_name(),
-            $this->get_this_model()->get_this_model_name()
-        );
-    }
-
-
-    /**
-     * Returns whatever is set as the $_schema_type property for the object.
-     * Note: this will automatically add 'null' to the schema if the object is_nullable()
-     *
-     * @return string
-     */
-    public function getSchemaType(): string
-    {
-        return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
-    }
-
-
-    /**
-     * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
-     * this method and return the properties for the schema.
-     * The reason this is not a property on the class is because there may be filters set on the values for the property
-     * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
-     *
-     * @return array
-     */
-    public function getSchemaProperties(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * If a child class has enum values, they should override this method and provide a simple array
-     * of the enum values.
-     * The reason this is not a property on the class is because there may be filterable enum values that
-     * are set on the instantiated object that could be filtered after construct.
-     *
-     * @return array
-     */
-    public function getSchemaEnum(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * This returns the value of the $_schema_format property on the object.
-     *
-     * @return array
-     */
-    public function getSchemaFormat(): array
-    {
-        return [];
-    }
-
-
-    /**
-     * This returns the value of the $_schema_readonly property on the object.
-     *
-     * @return bool
-     */
-    public function getSchemaReadonly(): bool
-    {
-        return true;
-    }
-
-
-    /**
-     * This returns elements used to represent this field in the json schema.
-     *
-     * @link http://json-schema.org/
-     * @return array
-     * @throws Exception
-     */
-    public function getSchema(): array
-    {
-        $schema = [
-            'description'   => $this->getSchemaDescription(),
-            'type'          => $this->getSchemaType(),
-            'relation'      => true,
-            'relation_type' => get_class($this),
-            'readonly'      => $this->getSchemaReadonly(),
-        ];
-
-        if ($this instanceof EE_HABTM_Relation) {
-            $schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
-        }
-
-        if ($this->getSchemaType() === 'array') {
-            $schema['items'] = [
-                'type' => 'object',
-            ];
-        }
-
-        return $schema;
-    }
+			return sprintf(
+				esc_html__(
+					'This %1$s is currently linked to one or more %2$s records. If this %1$s is incorrect, then please remove it from all %3$s before attempting to delete it.',
+					"event_espresso"
+				),
+				$this->get_this_model()->item_name(),
+				$this->get_other_model()->item_name(),
+				$this->get_other_model()->item_name(2)
+			);
+		}
+	}
+
+
+	/**
+	 * Returns whatever is set as the nicename for the object.
+	 *
+	 * @return string
+	 * @throws Exception
+	 */
+	public function getSchemaDescription(): string
+	{
+		$description = $this instanceof EE_Belongs_To_Relation
+			? esc_html__('The related %1$s entity to the %2$s.', 'event_espresso')
+			: esc_html__('The related %1$s entities to the %2$s.', 'event_espresso');
+		return sprintf(
+			$description,
+			$this->get_other_model()->get_this_model_name(),
+			$this->get_this_model()->get_this_model_name()
+		);
+	}
+
+
+	/**
+	 * Returns whatever is set as the $_schema_type property for the object.
+	 * Note: this will automatically add 'null' to the schema if the object is_nullable()
+	 *
+	 * @return string
+	 */
+	public function getSchemaType(): string
+	{
+		return $this instanceof EE_Belongs_To_Relation ? 'object' : 'array';
+	}
+
+
+	/**
+	 * This is usually present when the $_schema_type property is 'object'.  Any child classes will need to override
+	 * this method and return the properties for the schema.
+	 * The reason this is not a property on the class is because there may be filters set on the values for the property
+	 * that won't be exposed on construct.  For example enum type schemas may have the enum values filtered.
+	 *
+	 * @return array
+	 */
+	public function getSchemaProperties(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * If a child class has enum values, they should override this method and provide a simple array
+	 * of the enum values.
+	 * The reason this is not a property on the class is because there may be filterable enum values that
+	 * are set on the instantiated object that could be filtered after construct.
+	 *
+	 * @return array
+	 */
+	public function getSchemaEnum(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_format property on the object.
+	 *
+	 * @return array
+	 */
+	public function getSchemaFormat(): array
+	{
+		return [];
+	}
+
+
+	/**
+	 * This returns the value of the $_schema_readonly property on the object.
+	 *
+	 * @return bool
+	 */
+	public function getSchemaReadonly(): bool
+	{
+		return true;
+	}
+
+
+	/**
+	 * This returns elements used to represent this field in the json schema.
+	 *
+	 * @link http://json-schema.org/
+	 * @return array
+	 * @throws Exception
+	 */
+	public function getSchema(): array
+	{
+		$schema = [
+			'description'   => $this->getSchemaDescription(),
+			'type'          => $this->getSchemaType(),
+			'relation'      => true,
+			'relation_type' => get_class($this),
+			'readonly'      => $this->getSchemaReadonly(),
+		];
+
+		if ($this instanceof EE_HABTM_Relation) {
+			$schema['joining_model_name'] = $this->get_join_model()->get_this_model_name();
+		}
+
+		if ($this->getSchemaType() === 'array') {
+			$schema['items'] = [
+				'type' => 'object',
+			];
+		}
+
+		return $schema;
+	}
 }

Spacing +10 added lines, -10 removed lines

@@ -151,9 +151,9 @@ 
         string $extra_join_sql = ''
     ): string {
         return " 
-        LEFT JOIN " . $other_table . " AS " . $other_table_alias . " 
-        ON " . $other_table_alias . "." . $other_table_column
-               . "=" . $this_table_alias . "." . $this_table_join_column
+        LEFT JOIN " . $other_table." AS ".$other_table_alias." 
+        ON " . $other_table_alias.".".$other_table_column
+               . "=".$this_table_alias.".".$this_table_join_column
                . ($extra_join_sql ? " AND $extra_join_sql" : '');
     }
 
@@ -192,11 +192,11 @@ 
         $query_params = $this->_disable_default_where_conditions_on_query_param($query_params);
 
         $query_param_where_this_model_pk = $this->get_this_model()->get_this_model_name()
-                                           . "." . $this->get_this_model()->get_primary_key_field()->get_name();
+                                           . ".".$this->get_this_model()->get_primary_key_field()->get_name();
 
         $model_object_id = $this->_get_model_object_id($model_object_or_id);
 
-        $query_params[0][ $query_param_where_this_model_pk ] = $model_object_id;
+        $query_params[0][$query_param_where_this_model_pk] = $model_object_id;
         return $this->get_other_model()->get_all($query_params);
     }
 
@@ -209,7 +209,7 @@ 
      */
     protected function _disable_default_where_conditions_on_query_param(array $query_params): array
     {
-        if (! isset($query_params['default_where_conditions'])) {
+        if ( ! isset($query_params['default_where_conditions'])) {
             $query_params['default_where_conditions'] = 'none';
         }
         return $query_params;
@@ -241,7 +241,7 @@ 
                 $model_object_or_id
             );
             /* @var $model_object_or_id EE_Base_Class */
-            if (! $delete_is_blocked) {
+            if ( ! $delete_is_blocked) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $related_model_object->delete();
                 $deleted_count++;
@@ -279,7 +279,7 @@ 
             if ($related_model_object instanceof EE_Soft_Delete_Base_Class) {
                 $this->remove_relation_to($model_object_or_id, $related_model_object);
                 $deleted_count++;
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $related_model_object->delete_permanently();
                 } else {
                     // delete is blocked
@@ -288,7 +288,7 @@ 
                 }
             } else {
                 // its not a soft-deletable thing anyways. do the normal logic.
-                if (! $delete_is_blocked) {
+                if ( ! $delete_is_blocked) {
                     $this->remove_relation_to($model_object_or_id, $related_model_object);
                     $related_model_object->delete();
                     $deleted_count++;
@@ -314,7 +314,7 @@ 
         if ($model_object_or_id instanceof EE_Base_Class) {
             $model_object_id = $model_object_or_id->ID();
         }
-        if (! $model_object_id) {
+        if ( ! $model_object_id) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(