eventespresso / event-espresso-core

core/db_models/EEM_Form_Submission.model.php

Indentation +114 added lines, -114 removed lines

@@ -11,130 +11,130 @@
  */
 class EEM_Form_Submission extends EEM_Base
 {
-    /**
-     * @var EEM_Form_Submission
-     */
-    protected static $_instance;
+	/**
+	 * @var EEM_Form_Submission
+	 */
+	protected static $_instance;
 
-    /**
-     * @var RequestInterface
-     */
-    private $request;
+	/**
+	 * @var RequestInterface
+	 */
+	private $request;
 
 
-    /**
-     * EEM_Form_Submission constructor.
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Form Submission', 'event_espresso');
-        $this->plural_item   = esc_html__('Form Submissions', 'event_espresso');
+	/**
+	 * EEM_Form_Submission constructor.
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Form Submission', 'event_espresso');
+		$this->plural_item   = esc_html__('Form Submissions', 'event_espresso');
 
-        $this->_tables          = [
-            'Form_Submission' => new EE_Primary_Table('esp_form_submission', 'FSB_UUID'),
-        ];
-        $this->_fields          = [
-            'Form_Submission' => [
-                'FSB_UUID'      => new EE_Primary_Key_String_Field(
-                    'FSB_UUID',
-                    esc_html__('Form Submission UUID (universally unique identifier)', 'event_espresso')
-                ),
-                'FSC_UUID'      => new EE_Foreign_Key_String_Field(
-                    'FSC_UUID',
-                    esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso'),
-                    false,
-                    '',
-                    'Form_Section',
-                    false
-                ),
-                'TXN_ID'        => new EE_Foreign_Key_Int_Field(
-                    'TXN_ID',
-                    esc_html__('Transaction ID', 'event_espresso'),
-                    false,
-                    0,
-                    'Transaction'
-                ),
-                'FSB_data'      => new EE_JSON_Field(
-                    'FSB_data',
-                    esc_html__('Serialized form submission data', 'event_espresso'),
-                    true,
-                    null
-                ),
-                'FSB_submitted' => new EE_Datetime_Field(
-                    'FSB_submitted',
-                    esc_html__('Form submission timestamp', 'event_espresso'),
-                    false,
-                    EE_Datetime_Field::now,
-                    $timezone
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Form_Section' => new EE_Belongs_To_Relation(),
-            'Transaction'  => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-        $this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
-    }
+		$this->_tables          = [
+			'Form_Submission' => new EE_Primary_Table('esp_form_submission', 'FSB_UUID'),
+		];
+		$this->_fields          = [
+			'Form_Submission' => [
+				'FSB_UUID'      => new EE_Primary_Key_String_Field(
+					'FSB_UUID',
+					esc_html__('Form Submission UUID (universally unique identifier)', 'event_espresso')
+				),
+				'FSC_UUID'      => new EE_Foreign_Key_String_Field(
+					'FSC_UUID',
+					esc_html__('Form Section UUID (universally unique identifier)', 'event_espresso'),
+					false,
+					'',
+					'Form_Section',
+					false
+				),
+				'TXN_ID'        => new EE_Foreign_Key_Int_Field(
+					'TXN_ID',
+					esc_html__('Transaction ID', 'event_espresso'),
+					false,
+					0,
+					'Transaction'
+				),
+				'FSB_data'      => new EE_JSON_Field(
+					'FSB_data',
+					esc_html__('Serialized form submission data', 'event_espresso'),
+					true,
+					null
+				),
+				'FSB_submitted' => new EE_Datetime_Field(
+					'FSB_submitted',
+					esc_html__('Form submission timestamp', 'event_espresso'),
+					false,
+					EE_Datetime_Field::now,
+					$timezone
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Form_Section' => new EE_Belongs_To_Relation(),
+			'Transaction'  => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+		$this->request = $this->getLoader()->getShared('EventEspresso\core\services\request\RequestInterface');
+	}
 
 
-    /**
-     * adds all default where conditions unless the current request originates from the admin
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addDefaultWhereConditions(array $query_params): array
-    {
-        // might need to add a way to identify GQL requests for admin domains
-        $query_params['default_where_conditions'] = $this->request->isAdmin() || $this->request->isAdminAjax()
-            ? EEM_Base::default_where_conditions_none
-            : EEM_Base::default_where_conditions_all;
-        return $query_params;
-    }
+	/**
+	 * adds all default where conditions unless the current request originates from the admin
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addDefaultWhereConditions(array $query_params): array
+	{
+		// might need to add a way to identify GQL requests for admin domains
+		$query_params['default_where_conditions'] = $this->request->isAdmin() || $this->request->isAdminAjax()
+			? EEM_Base::default_where_conditions_none
+			: EEM_Base::default_where_conditions_all;
+		return $query_params;
+	}
 
 
-    /**
-     * form sections should always be sorted in ascending order via the FSC_order field
-     *
-     * @param array $query_params
-     * @return array
-     */
-    private function addOrderByQueryParams(array $query_params): array
-    {
-        $query_params['order_by'] = ['FSB_submitted' => 'ASC'];
-        return $query_params;
-    }
+	/**
+	 * form sections should always be sorted in ascending order via the FSC_order field
+	 *
+	 * @param array $query_params
+	 * @return array
+	 */
+	private function addOrderByQueryParams(array $query_params): array
+	{
+		$query_params['order_by'] = ['FSB_submitted' => 'ASC'];
+		return $query_params;
+	}
 
 
-    /**
-     * @param EE_Event $event
-     * @return EE_Form_Submission[]|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getAllFormSubmissionsForEvent(EE_Event $event): ?array
-    {
-        $query_params = [['FSC_UUID' => $event->registrationFormUuid()]];
-        $query_params = $this->addDefaultWhereConditions($query_params);
-        $query_params = $this->addOrderByQueryParams($query_params);
-        return $this->get_all($query_params);
-    }
+	/**
+	 * @param EE_Event $event
+	 * @return EE_Form_Submission[]|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getAllFormSubmissionsForEvent(EE_Event $event): ?array
+	{
+		$query_params = [['FSC_UUID' => $event->registrationFormUuid()]];
+		$query_params = $this->addDefaultWhereConditions($query_params);
+		$query_params = $this->addOrderByQueryParams($query_params);
+		return $this->get_all($query_params);
+	}
 
 
-    /**
-     * @param EE_Transaction $transaction
-     * @return EE_Form_Submission|null
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function getFormSubmissionForTransaction(EE_Transaction $transaction): ?EE_Form_Submission
-    {
-        $query_params = [['TXN_ID' => $transaction->ID()]];
-        $query_params = $this->addDefaultWhereConditions($query_params);
-        return $this->get_one($query_params);
-    }
+	/**
+	 * @param EE_Transaction $transaction
+	 * @return EE_Form_Submission|null
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function getFormSubmissionForTransaction(EE_Transaction $transaction): ?EE_Form_Submission
+	{
+		$query_params = [['TXN_ID' => $transaction->ID()]];
+		$query_params = $this->addDefaultWhereConditions($query_params);
+		return $this->get_one($query_params);
+	}
 }

core/db_models/EEM_Ticket_Price.model.php

Indentation +43 added lines, -43 removed lines

@@ -10,50 +10,50 @@
  */
 class EEM_Ticket_Price extends EEM_Base
 {
-    // private instance of the EEM_Ticket_Price object
-    protected static $_instance = null;
+	// private instance of the EEM_Ticket_Price object
+	protected static $_instance = null;
 
 
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
-     *                              any incoming timezone data that gets saved).  Note this just sends the timezone
-     *                              info to the date time model field objects.  Default is NULL (and will be assumed
-     *                              using the set timezone in the 'timezone_string' wp option)
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item = esc_html__('Ticket Price', 'event_espresso');
-        $this->plural_item   = esc_html__('Ticket Prices', 'event_espresso');
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone string representing the timezone we want to set for returned Date Time Strings (and
+	 *                              any incoming timezone data that gets saved).  Note this just sends the timezone
+	 *                              info to the date time model field objects.  Default is NULL (and will be assumed
+	 *                              using the set timezone in the 'timezone_string' wp option)
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item = esc_html__('Ticket Price', 'event_espresso');
+		$this->plural_item   = esc_html__('Ticket Prices', 'event_espresso');
 
-        $this->_tables                                            = [
-            'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID'),
-        ];
-        $this->_fields                                            = [
-            'Ticket_Price' => [
-                'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
-                'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
-                'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
-            ],
-        ];
-        $this->_model_relations                                   = [
-            'Ticket' => new EE_Belongs_To_Relation(),
-            'Price'  => new EE_Belongs_To_Relation(),
-        ];
-        $this->_model_chain_to_wp_user                            = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
-            new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
-            new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        // follow the caps of the ticket
-        $this->_caps_slug = 'tickets';
-        parent::__construct($timezone);
-    }
+		$this->_tables                                            = [
+			'Ticket_Price' => new EE_Primary_Table('esp_ticket_price', 'TKP_ID'),
+		];
+		$this->_fields                                            = [
+			'Ticket_Price' => [
+				'TKP_ID' => new EE_Primary_Key_Int_Field('TKP_ID', 'Ticket Price ID'),
+				'TKT_ID' => new EE_Foreign_Key_Int_Field('TKT_ID', 'Ticket Id', false, 0, 'Ticket'),
+				'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
+			],
+		];
+		$this->_model_relations                                   = [
+			'Ticket' => new EE_Belongs_To_Relation(),
+			'Price'  => new EE_Belongs_To_Relation(),
+		];
+		$this->_model_chain_to_wp_user                            = 'Ticket';
+		$this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+			new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// account for default tickets in the caps
+		$this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		$this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+			new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
+		// follow the caps of the ticket
+		$this->_caps_slug = 'tickets';
+		parent::__construct($timezone);
+	}
 }

Spacing +5 added lines, -5 removed lines

@@ -38,19 +38,19 @@
                 'PRC_ID' => new EE_Foreign_Key_Int_Field('PRC_ID', 'Price ID', false, 0, 'Price'),
             ],
         ];
-        $this->_model_relations                                   = [
+        $this->_model_relations = [
             'Ticket' => new EE_Belongs_To_Relation(),
             'Price'  => new EE_Belongs_To_Relation(),
         ];
         $this->_model_chain_to_wp_user                            = 'Ticket';
-        $this->_cap_restriction_generators[ EEM_Base::caps_read ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read] =
             new EE_Restriction_Generator_Default_Public('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // account for default tickets in the caps
-        $this->_cap_restriction_generators[ EEM_Base::caps_read_admin ] =
+        $this->_cap_restriction_generators[EEM_Base::caps_read_admin] =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_edit ]       =
+        $this->_cap_restriction_generators[EEM_Base::caps_edit]       =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
-        $this->_cap_restriction_generators[ EEM_Base::caps_delete ]     =
+        $this->_cap_restriction_generators[EEM_Base::caps_delete]     =
             new EE_Restriction_Generator_Default_Protected('Ticket.TKT_is_default', 'Ticket.Datetime.Event');
         // follow the caps of the ticket
         $this->_caps_slug = 'tickets';

core/db_models/EEM_Form_Element.model.php

Indentation +217 added lines, -217 removed lines

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

core/db_models/EEM_Change_Log.model.php

Indentation +226 added lines, -226 removed lines

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

core/db_models/EEM_Payment_Method.model.php

Indentation +452 added lines, -452 removed lines

@@ -16,456 +16,456 @@
  */
 class EEM_Payment_Method extends EEM_Base
 {
-    const scope_cart  = 'CART';
-
-    const scope_admin = 'ADMIN';
-
-    const scope_api   = 'API';
-
-    /**
-     * @type EEM_Payment_Method
-     */
-    protected static $_instance = null;
-
-
-    /**
-     * private constructor to prevent direct creation
-     *
-     * @param string|null $timezone
-     * @throws EE_Error
-     */
-    protected function __construct(?string $timezone = '')
-    {
-        $this->singular_item    = esc_html__('Payment Method', 'event_espresso');
-        $this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
-        $this->_tables          = [
-            'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
-        ];
-        $this->_fields          = [
-            'Payment_Method' => [
-                'PMD_ID'              => new EE_Primary_Key_Int_Field(
-                    'PMD_ID',
-                    esc_html__('ID', 'event_espresso')
-                ),
-                'PMD_type'            => new EE_Plain_Text_Field(
-                    'PMD_type',
-                    esc_html__('Payment Method Type', 'event_espresso'),
-                    false,
-                    'Admin_Only'
-                ),
-                'PMD_name'            => new EE_Plain_Text_Field(
-                    'PMD_name',
-                    esc_html__('Name', 'event_espresso'),
-                    false
-                ),
-                'PMD_desc'            => new EE_Post_Content_Field(
-                    'PMD_desc',
-                    esc_html__('Description', 'event_espresso'),
-                    false,
-                    ''
-                ),
-                'PMD_admin_name'      => new EE_Plain_Text_Field(
-                    'PMD_admin_name',
-                    esc_html__('Admin-Only Name', 'event_espresso'),
-                    true
-                ),
-                'PMD_admin_desc'      => new EE_Post_Content_Field(
-                    'PMD_admin_desc',
-                    esc_html__('Admin-Only Description', 'event_espresso'),
-                    true
-                ),
-                'PMD_slug'            => new EE_Slug_Field(
-                    'PMD_slug',
-                    esc_html__('Slug', 'event_espresso'),
-                    false
-                ),
-                'PMD_order'           => new EE_Integer_Field(
-                    'PMD_order',
-                    esc_html__('Order', 'event_espresso'),
-                    false,
-                    0
-                ),
-                'PMD_debug_mode'      => new EE_Boolean_Field(
-                    'PMD_debug_mode',
-                    esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_wp_user'         => new EE_WP_User_Field(
-                    'PMD_wp_user',
-                    esc_html__('Payment Method Creator ID', 'event_espresso'),
-                    false
-                ),
-                'PMD_open_by_default' => new EE_Boolean_Field(
-                    'PMD_open_by_default',
-                    esc_html__('Open by Default?', 'event_espresso'),
-                    false,
-                    false
-                ),
-                'PMD_button_url'      => new EE_Plain_Text_Field(
-                    'PMD_button_url',
-                    esc_html__('Button URL', 'event_espresso'),
-                    true,
-                    ''
-                ),
-                'PMD_scope'           => new EE_Serialized_Text_Field(
-                    'PMD_scope',
-                    esc_html__('Usable From?', 'event_espresso'),
-                    false,
-                    []// possible values currently are 'CART','ADMIN','API'
-                ),
-            ],
-        ];
-        $this->_model_relations = [
-            'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
-            'Payment'     => new EE_Has_Many_Relation(),
-            'Transaction' => new EE_Has_Many_Relation(),
-            'WP_User'     => new EE_Belongs_To_Relation(),
-        ];
-        parent::__construct($timezone);
-    }
-
-
-    /**
-     * Gets one by the slug provided
-     *
-     * @param string $slug
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_by_slug($slug)
-    {
-        return $this->get_one([['PMD_slug' => $slug]]);
-    }
-
-
-    /**
-     * Gets all the acceptable scopes for payment methods.
-     * Keys are their names as store din the DB, and values are nice names for displaying them
-     *
-     * @return array
-     */
-    public function scopes()
-    {
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__scopes',
-            [
-                EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
-                EEM_Payment_Method::scope_admin => esc_html__(
-                    'Admin Registration Page (no online processing)',
-                    'event_espresso'
-                ),
-            ]
-        );
-    }
-
-
-    /**
-     * Determines if this is an valid scope
-     *
-     * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
-     * @return boolean
-     */
-    public function is_valid_scope($scope)
-    {
-        $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
-            return true;
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets all active payment methods
-     *
-     * @param string $scope one of
-     * @param array  $query_params
-     * @return EE_Base_Class[]|EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_active($scope = null, $query_params = [])
-    {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
-            $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
-        }
-        return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Counts all active gateways in the specified scope
-     *
-     * @param string $scope one of EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return int
-     * @throws EE_Error
-     */
-    public function count_active($scope = null, $query_params = [])
-    {
-        return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    protected function _get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        if ($scope) {
-            if ($this->is_valid_scope($scope)) {
-                return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
-            }
-            throw new EE_Error(
-                sprintf(
-                    esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
-                    $scope
-                )
-            );
-        }
-        $acceptable_scopes = [];
-        $count             = 0;
-        foreach ($this->scopes() as $scope_name => $desc) {
-            $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
-        }
-        return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
-    }
-
-
-    /**
-     * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
-     * argument to get all active for a given scope
-     *
-     * @param string $scope one of the constants EEM_Payment_Method::scope_*
-     * @param array  $query_params
-     * @return array
-     * @throws EE_Error
-     * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
-     */
-    public function get_query_params_for_all_active($scope = null, $query_params = [])
-    {
-        return $this->_get_query_params_for_all_active($scope, $query_params);
-    }
-
-
-    /**
-     * Gets one active payment method. see @get_all_active for documentation
-     *
-     * @param string $scope
-     * @param array  $query_params
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_active($scope = null, $query_params = [])
-    {
-        return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
-    }
-
-
-    /**
-     * Gets one payment method of that type, regardless of whether its active or not
-     *
-     * @param string $type
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
-     * @throws EE_Error
-     */
-    public function get_one_of_type($type)
-    {
-        return $this->get_one([['PMD_type' => $type]]);
-    }
-
-
-    /**
-     * Overrides parent ot also check by the slug
-     *
-     * @param string|int|EE_Payment_Method $base_class_obj_or_id
-     * @param boolean                      $ensure_is_in_db
-     * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
-     * @throws EE_Error
-     * @see EEM_Base::ensure_is_obj()
-     */
-    public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
-    {
-        // first: check if it's a slug
-        if (is_string($base_class_obj_or_id)) {
-            $obj = $this->get_one_by_slug($base_class_obj_or_id);
-            if ($obj) {
-                return $obj;
-            }
-        }
-        // ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
-        try {
-            return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
-        } catch (EE_Error $e) {
-            // handle it outside the catch
-        }
-        throw new EE_Error(
-            sprintf(
-                esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
-                $base_class_obj_or_id
-            )
-        );
-    }
-
-
-    /**
-     * Gets the ID of this object, or if its a string finds the object's id
-     * associated with that slug
-     *
-     * @param mixed $base_obj_or_id_or_slug
-     * @return int
-     * @throws EE_Error
-     */
-    public function ensure_is_ID($base_obj_or_id_or_slug)
-    {
-        if (is_string($base_obj_or_id_or_slug)) {
-            // assume it's a slug
-            $base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
-        }
-        return parent::ensure_is_ID($base_obj_or_id_or_slug);
-    }
-
-
-    /**
-     * Verifies the button urls on all the passed payment methods have a valid button url.
-     * If not, resets them to their default.
-     *
-     * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
-     * @throws EE_Error
-     * @throws ReflectionException
-     */
-    public function verify_button_urls($payment_methods = null)
-    {
-        $payment_methods = is_array($payment_methods)
-            ? $payment_methods
-            : $this->get_all_active(EEM_Payment_Method::scope_cart);
-        foreach ($payment_methods as $payment_method) {
-            try {
-                // If there is really no button URL at all, or if the button URLs still point to decaf folder even
-                // though this is a caffeinated install, reset it to the default.
-                $current_button_url = $payment_method->button_url();
-                if (
-                    empty($current_button_url)
-                    || (
-                        strpos($current_button_url, 'decaf') !== false
-                        && strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
-                    )
-                ) {
-                    $payment_method->save(
-                        [
-                            'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
-                        ]
-                    );
-                }
-            } catch (EE_Error $e) {
-                $payment_method->deactivate();
-            }
-        }
-    }
-
-
-    /**
-     * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
-     * but also verifies the payment method type of each is a usable object. If not,
-     * deactivate it, sets a notification, and deactivates it
-     *
-     * @param array $rows
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     * @throws InvalidDataTypeException
-     * @throws ReflectionException
-     */
-    protected function _create_objects($rows = [])
-    {
-        EE_Registry::instance()->load_lib('Payment_Method_Manager');
-        $payment_methods = parent::_create_objects($rows);
-        /* @var $payment_methods EE_Payment_Method[] */
-        $usable_payment_methods = [];
-        foreach ($payment_methods as $key => $payment_method) {
-            if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
-                // some payment methods enqueue their scripts in EE_PMT_*::__construct
-                // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
-                // its scripts). but for backwards-compat we should continue to do that
-                $payment_method->type_obj();
-            } elseif ($payment_method->active()) {
-                // only deactivate and notify the admin if the payment is active somewhere
-                $payment_method->deactivate();
-                $payment_method->save();
-                do_action(
-                    'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
-                    $payment_method
-                );
-                new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
-                    sprintf(
-                        esc_html__(
-                            'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
-                            'event_espresso'
-                        ),
-                        $payment_method->admin_name(),
-                        '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
-                        '</a>'
-                    ),
-                    true
-                );
-            }
-        }
-        return $usable_payment_methods;
-    }
-
-
-    /**
-     * Gets all the payment methods which can be used for transaction
-     * (according to the relations between payment methods and events, and
-     * the currencies used for the transaction and their relation to payment methods)
-     *
-     * @param EE_Transaction $transaction
-     * @param string         $scope @see EEM_Payment_Method::get_all_for_events
-     * @return EE_Payment_Method[]
-     * @throws EE_Error
-     */
-    public function get_all_for_transaction($transaction, $scope)
-    {
-        // give addons a chance to override what payment methods are chosen based on the transaction
-        return apply_filters(
-            'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
-            $this->get_all_active($scope, ['group_by' => 'PMD_type']),
-            $transaction,
-            $scope
-        );
-    }
-
-
-    /**
-     * Returns the payment method used for the last payment made for a registration.
-     * Note: if an offline payment method was selected on the related transaction then this will have no payment
-     * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
-     *
-     * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
-     *                                                    registration.
-     * @return EE_Payment|null
-     * @throws EE_Error
-     */
-    public function get_last_used_for_registration($registration_or_reg_id)
-    {
-        $registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
-
-        $query_params = [
-            0          => [
-                'Payment.Registration.REG_ID' => $registration_id,
-            ],
-            'order_by' => ['Payment.PAY_ID' => 'DESC'],
-        ];
-        return $this->get_one($query_params);
-    }
+	const scope_cart  = 'CART';
+
+	const scope_admin = 'ADMIN';
+
+	const scope_api   = 'API';
+
+	/**
+	 * @type EEM_Payment_Method
+	 */
+	protected static $_instance = null;
+
+
+	/**
+	 * private constructor to prevent direct creation
+	 *
+	 * @param string|null $timezone
+	 * @throws EE_Error
+	 */
+	protected function __construct(?string $timezone = '')
+	{
+		$this->singular_item    = esc_html__('Payment Method', 'event_espresso');
+		$this->plural_item      = esc_html__('Payment Methods', 'event_espresso');
+		$this->_tables          = [
+			'Payment_Method' => new EE_Primary_Table('esp_payment_method', 'PMD_ID'),
+		];
+		$this->_fields          = [
+			'Payment_Method' => [
+				'PMD_ID'              => new EE_Primary_Key_Int_Field(
+					'PMD_ID',
+					esc_html__('ID', 'event_espresso')
+				),
+				'PMD_type'            => new EE_Plain_Text_Field(
+					'PMD_type',
+					esc_html__('Payment Method Type', 'event_espresso'),
+					false,
+					'Admin_Only'
+				),
+				'PMD_name'            => new EE_Plain_Text_Field(
+					'PMD_name',
+					esc_html__('Name', 'event_espresso'),
+					false
+				),
+				'PMD_desc'            => new EE_Post_Content_Field(
+					'PMD_desc',
+					esc_html__('Description', 'event_espresso'),
+					false,
+					''
+				),
+				'PMD_admin_name'      => new EE_Plain_Text_Field(
+					'PMD_admin_name',
+					esc_html__('Admin-Only Name', 'event_espresso'),
+					true
+				),
+				'PMD_admin_desc'      => new EE_Post_Content_Field(
+					'PMD_admin_desc',
+					esc_html__('Admin-Only Description', 'event_espresso'),
+					true
+				),
+				'PMD_slug'            => new EE_Slug_Field(
+					'PMD_slug',
+					esc_html__('Slug', 'event_espresso'),
+					false
+				),
+				'PMD_order'           => new EE_Integer_Field(
+					'PMD_order',
+					esc_html__('Order', 'event_espresso'),
+					false,
+					0
+				),
+				'PMD_debug_mode'      => new EE_Boolean_Field(
+					'PMD_debug_mode',
+					esc_html__('Sandbox Mode On? (AKA: debug mode)', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_wp_user'         => new EE_WP_User_Field(
+					'PMD_wp_user',
+					esc_html__('Payment Method Creator ID', 'event_espresso'),
+					false
+				),
+				'PMD_open_by_default' => new EE_Boolean_Field(
+					'PMD_open_by_default',
+					esc_html__('Open by Default?', 'event_espresso'),
+					false,
+					false
+				),
+				'PMD_button_url'      => new EE_Plain_Text_Field(
+					'PMD_button_url',
+					esc_html__('Button URL', 'event_espresso'),
+					true,
+					''
+				),
+				'PMD_scope'           => new EE_Serialized_Text_Field(
+					'PMD_scope',
+					esc_html__('Usable From?', 'event_espresso'),
+					false,
+					[]// possible values currently are 'CART','ADMIN','API'
+				),
+			],
+		];
+		$this->_model_relations = [
+			'Currency'    => new EE_HABTM_Relation('Currency_Payment_Method'),
+			'Payment'     => new EE_Has_Many_Relation(),
+			'Transaction' => new EE_Has_Many_Relation(),
+			'WP_User'     => new EE_Belongs_To_Relation(),
+		];
+		parent::__construct($timezone);
+	}
+
+
+	/**
+	 * Gets one by the slug provided
+	 *
+	 * @param string $slug
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_by_slug($slug)
+	{
+		return $this->get_one([['PMD_slug' => $slug]]);
+	}
+
+
+	/**
+	 * Gets all the acceptable scopes for payment methods.
+	 * Keys are their names as store din the DB, and values are nice names for displaying them
+	 *
+	 * @return array
+	 */
+	public function scopes()
+	{
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__scopes',
+			[
+				EEM_Payment_Method::scope_cart  => esc_html__('Front-end Registration Page', 'event_espresso'),
+				EEM_Payment_Method::scope_admin => esc_html__(
+					'Admin Registration Page (no online processing)',
+					'event_espresso'
+				),
+			]
+		);
+	}
+
+
+	/**
+	 * Determines if this is an valid scope
+	 *
+	 * @param string $scope like one of EEM_Payment_Method::instance()->scopes()
+	 * @return boolean
+	 */
+	public function is_valid_scope($scope)
+	{
+		$scopes = $this->scopes();
+		if (isset($scopes[ $scope ])) {
+			return true;
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets all active payment methods
+	 *
+	 * @param string $scope one of
+	 * @param array  $query_params
+	 * @return EE_Base_Class[]|EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_active($scope = null, $query_params = [])
+	{
+		if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+			$query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
+		}
+		return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Counts all active gateways in the specified scope
+	 *
+	 * @param string $scope one of EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function count_active($scope = null, $query_params = [])
+	{
+		return $this->count($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	protected function _get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		if ($scope) {
+			if ($this->is_valid_scope($scope)) {
+				return array_replace_recursive([['PMD_scope' => ['LIKE', "%$scope%"]]], $query_params);
+			}
+			throw new EE_Error(
+				sprintf(
+					esc_html__("'%s' is not a valid scope for a payment method", 'event_espresso'),
+					$scope
+				)
+			);
+		}
+		$acceptable_scopes = [];
+		$count             = 0;
+		foreach ($this->scopes() as $scope_name => $desc) {
+			$count++;
+			$acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+		}
+		return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
+	}
+
+
+	/**
+	 * Creates the $query_params that can be passed into any EEM_Payment_Method as their $query_params
+	 * argument to get all active for a given scope
+	 *
+	 * @param string $scope one of the constants EEM_Payment_Method::scope_*
+	 * @param array  $query_params
+	 * @return array
+	 * @throws EE_Error
+	 * @see https://github.com/eventespresso/event-espresso-core/tree/master/docs/G--Model-System/model-query-params.md
+	 */
+	public function get_query_params_for_all_active($scope = null, $query_params = [])
+	{
+		return $this->_get_query_params_for_all_active($scope, $query_params);
+	}
+
+
+	/**
+	 * Gets one active payment method. see @get_all_active for documentation
+	 *
+	 * @param string $scope
+	 * @param array  $query_params
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_active($scope = null, $query_params = [])
+	{
+		return $this->get_one($this->_get_query_params_for_all_active($scope, $query_params));
+	}
+
+
+	/**
+	 * Gets one payment method of that type, regardless of whether its active or not
+	 *
+	 * @param string $type
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|NULL
+	 * @throws EE_Error
+	 */
+	public function get_one_of_type($type)
+	{
+		return $this->get_one([['PMD_type' => $type]]);
+	}
+
+
+	/**
+	 * Overrides parent ot also check by the slug
+	 *
+	 * @param string|int|EE_Payment_Method $base_class_obj_or_id
+	 * @param boolean                      $ensure_is_in_db
+	 * @return EE_Base_Class|EE_Payment_Method|EE_Soft_Delete_Base_Class|int|string
+	 * @throws EE_Error
+	 * @see EEM_Base::ensure_is_obj()
+	 */
+	public function ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db = false)
+	{
+		// first: check if it's a slug
+		if (is_string($base_class_obj_or_id)) {
+			$obj = $this->get_one_by_slug($base_class_obj_or_id);
+			if ($obj) {
+				return $obj;
+			}
+		}
+		// ok so it wasn't a slug we were passed. try the usual then (ie, it's an object or an ID)
+		try {
+			return parent::ensure_is_obj($base_class_obj_or_id, $ensure_is_in_db);
+		} catch (EE_Error $e) {
+			// handle it outside the catch
+		}
+		throw new EE_Error(
+			sprintf(
+				esc_html__("'%s' is neither a Payment Method ID, slug, nor object.", 'event_espresso'),
+				$base_class_obj_or_id
+			)
+		);
+	}
+
+
+	/**
+	 * Gets the ID of this object, or if its a string finds the object's id
+	 * associated with that slug
+	 *
+	 * @param mixed $base_obj_or_id_or_slug
+	 * @return int
+	 * @throws EE_Error
+	 */
+	public function ensure_is_ID($base_obj_or_id_or_slug)
+	{
+		if (is_string($base_obj_or_id_or_slug)) {
+			// assume it's a slug
+			$base_obj_or_id_or_slug = $this->get_one_by_slug($base_obj_or_id_or_slug);
+		}
+		return parent::ensure_is_ID($base_obj_or_id_or_slug);
+	}
+
+
+	/**
+	 * Verifies the button urls on all the passed payment methods have a valid button url.
+	 * If not, resets them to their default.
+	 *
+	 * @param EE_Payment_Method[] $payment_methods if NULL, defaults to all payment methods active in the cart
+	 * @throws EE_Error
+	 * @throws ReflectionException
+	 */
+	public function verify_button_urls($payment_methods = null)
+	{
+		$payment_methods = is_array($payment_methods)
+			? $payment_methods
+			: $this->get_all_active(EEM_Payment_Method::scope_cart);
+		foreach ($payment_methods as $payment_method) {
+			try {
+				// If there is really no button URL at all, or if the button URLs still point to decaf folder even
+				// though this is a caffeinated install, reset it to the default.
+				$current_button_url = $payment_method->button_url();
+				if (
+					empty($current_button_url)
+					|| (
+						strpos($current_button_url, 'decaf') !== false
+						&& strpos($payment_method->type_obj()->default_button_url(), 'decaf') === false
+					)
+				) {
+					$payment_method->save(
+						[
+							'PMD_button_url' => $payment_method->type_obj()->default_button_url(),
+						]
+					);
+				}
+			} catch (EE_Error $e) {
+				$payment_method->deactivate();
+			}
+		}
+	}
+
+
+	/**
+	 * Overrides parent to not only turn wpdb results into EE_Payment_Method objects,
+	 * but also verifies the payment method type of each is a usable object. If not,
+	 * deactivate it, sets a notification, and deactivates it
+	 *
+	 * @param array $rows
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 * @throws InvalidDataTypeException
+	 * @throws ReflectionException
+	 */
+	protected function _create_objects($rows = [])
+	{
+		EE_Registry::instance()->load_lib('Payment_Method_Manager');
+		$payment_methods = parent::_create_objects($rows);
+		/* @var $payment_methods EE_Payment_Method[] */
+		$usable_payment_methods = [];
+		foreach ($payment_methods as $key => $payment_method) {
+			if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
+				$usable_payment_methods[ $key ] = $payment_method;
+				// some payment methods enqueue their scripts in EE_PMT_*::__construct
+				// which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
+				// its scripts). but for backwards-compat we should continue to do that
+				$payment_method->type_obj();
+			} elseif ($payment_method->active()) {
+				// only deactivate and notify the admin if the payment is active somewhere
+				$payment_method->deactivate();
+				$payment_method->save();
+				do_action(
+					'AHEE__EEM_Payment_Method___create_objects_auto_deactivated_payment_method',
+					$payment_method
+				);
+				new PersistentAdminNotice(
+					'auto-deactivated-' . $payment_method->type(),
+					sprintf(
+						esc_html__(
+							'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
+							'event_espresso'
+						),
+						$payment_method->admin_name(),
+						'<br />',
+						'<a href="' . admin_url('plugins.php') . '">',
+						'</a>'
+					),
+					true
+				);
+			}
+		}
+		return $usable_payment_methods;
+	}
+
+
+	/**
+	 * Gets all the payment methods which can be used for transaction
+	 * (according to the relations between payment methods and events, and
+	 * the currencies used for the transaction and their relation to payment methods)
+	 *
+	 * @param EE_Transaction $transaction
+	 * @param string         $scope @see EEM_Payment_Method::get_all_for_events
+	 * @return EE_Payment_Method[]
+	 * @throws EE_Error
+	 */
+	public function get_all_for_transaction($transaction, $scope)
+	{
+		// give addons a chance to override what payment methods are chosen based on the transaction
+		return apply_filters(
+			'FHEE__EEM_Payment_Method__get_all_for_transaction__payment_methods',
+			$this->get_all_active($scope, ['group_by' => 'PMD_type']),
+			$transaction,
+			$scope
+		);
+	}
+
+
+	/**
+	 * Returns the payment method used for the last payment made for a registration.
+	 * Note: if an offline payment method was selected on the related transaction then this will have no payment
+	 * methods returned. It will ONLY return a payment method for a PAYMENT recorded against the registration.
+	 *
+	 * @param EE_Registration|int $registration_or_reg_id Either the EE_Registration object or the id for the
+	 *                                                    registration.
+	 * @return EE_Payment|null
+	 * @throws EE_Error
+	 */
+	public function get_last_used_for_registration($registration_or_reg_id)
+	{
+		$registration_id = EEM_Registration::instance()->ensure_is_ID($registration_or_reg_id);
+
+		$query_params = [
+			0          => [
+				'Payment.Registration.REG_ID' => $registration_id,
+			],
+			'order_by' => ['Payment.PAY_ID' => 'DESC'],
+		];
+		return $this->get_one($query_params);
+	}
 }

Spacing +6 added lines, -6 removed lines

@@ -169,7 +169,7 @@ 
     public function is_valid_scope($scope)
     {
         $scopes = $this->scopes();
-        if (isset($scopes[ $scope ])) {
+        if (isset($scopes[$scope])) {
             return true;
         }
         return false;
@@ -186,7 +186,7 @@ 
      */
     public function get_all_active($scope = null, $query_params = [])
     {
-        if (! isset($query_params['order_by']) && ! isset($query_params['order'])) {
+        if ( ! isset($query_params['order_by']) && ! isset($query_params['order'])) {
             $query_params['order_by'] = ['PMD_order' => 'ASC', 'PMD_ID' => 'ASC'];
         }
         return $this->get_all($this->_get_query_params_for_all_active($scope, $query_params));
@@ -234,7 +234,7 @@ 
         $count             = 0;
         foreach ($this->scopes() as $scope_name => $desc) {
             $count++;
-            $acceptable_scopes[ 'PMD_scope*' . $count ] = ['LIKE', '%' . $scope_name . '%'];
+            $acceptable_scopes['PMD_scope*'.$count] = ['LIKE', '%'.$scope_name.'%'];
         }
         return array_replace_recursive([['OR*active_scope' => $acceptable_scopes]], $query_params);
     }
@@ -391,7 +391,7 @@ 
         $usable_payment_methods = [];
         foreach ($payment_methods as $key => $payment_method) {
             if (EE_Payment_Method_Manager::instance()->payment_method_type_exists($payment_method->type())) {
-                $usable_payment_methods[ $key ] = $payment_method;
+                $usable_payment_methods[$key] = $payment_method;
                 // some payment methods enqueue their scripts in EE_PMT_*::__construct
                 // which is kinda a no-no (just because it's being constructed doesn't mean we need to enqueue
                 // its scripts). but for backwards-compat we should continue to do that
@@ -405,7 +405,7 @@ 
                     $payment_method
                 );
                 new PersistentAdminNotice(
-                    'auto-deactivated-' . $payment_method->type(),
+                    'auto-deactivated-'.$payment_method->type(),
                     sprintf(
                         esc_html__(
                             'The payment method %1$s was automatically deactivated because it appears its associated Event Espresso Addon was recently deactivated.%2$sIt can be reactivated on the %3$sPlugins admin page%4$s, then you can reactivate the payment method.',
@@ -413,7 +413,7 @@ 
                         ),
                         $payment_method->admin_name(),
                         '<br />',
-                        '<a href="' . admin_url('plugins.php') . '">',
+                        '<a href="'.admin_url('plugins.php').'">',
                         '</a>'
                     ),
                     true

core/libraries/form_sections/strategies/display/EE_Display_Strategy_Base.strategy.php

Indentation +225 added lines, -225 removed lines

@@ -10,229 +10,229 @@
  */
 abstract class EE_Display_Strategy_Base extends EE_Form_Input_Strategy_Base
 {
-    /**
-     * @var string $_tag
-     */
-    protected string $_tag = '';
-
-
-    /**
-     * returns HTML and javascript related to the displaying of this input
-     *
-     * @return string
-     */
-    abstract public function display(): string;
-
-
-    /**
-     * _remove_chars - takes an incoming string, and removes the string $chars from the end of it, but only if $chars
-     * is already there
-     *
-     * @param string $string - the string being processed
-     * @param string $chars  - exact string of characters to remove
-     * @return string
-     */
-    protected function _remove_chars(string $string = '', string $chars = '-'): string
-    {
-        $char_length = strlen($chars) * -1;
-        // if last three characters of string is  " - ", then remove it
-        return substr($string, $char_length) === $chars
-            ? substr($string, 0, $char_length)
-            : $string;
-    }
-
-
-    /**
-     * _append_chars - takes an incoming string, and adds the string $chars to the end of it, but only if $chars is not
-     * already there
-     *
-     * @param string $string - the string being processed
-     * @param string $chars  - exact string of characters to be added to end of string
-     * @return string
-     */
-    protected function _append_chars(string $string = '', string $chars = '-'): string
-    {
-        return $this->_remove_chars($string, $chars) . $chars;
-    }
-
-
-    /**
-     * Gets the HTML IDs of all the inputs
-     *
-     * @param bool $add_pound_sign
-     * @return array
-     * @throws EE_Error
-     */
-    public function get_html_input_ids(bool $add_pound_sign = false): array
-    {
-        return [$this->get_input()->html_id($add_pound_sign)];
-    }
-
-
-    /**
-     * Adds js variables for localization to the $other_js_data. These should be put
-     * in each form's "other_data" javascript object.
-     *
-     * @param array $other_js_data
-     * @return array
-     */
-    public function get_other_js_data(array $other_js_data = []): array
-    {
-        return $other_js_data;
-    }
-
-
-    /**
-     * Opportunity for this display strategy to call wp_enqueue_script and wp_enqueue_style.
-     * This should be called during wp_enqueue_scripts
-     */
-    public function enqueue_js()
-    {
-    }
-
-
-    /**
-     * returns string like: '<tag'
-     *
-     * @param string $tag
-     * @return string
-     */
-    protected function _opening_tag(string $tag): string
-    {
-        $this->_tag = $tag;
-        return "<$this->_tag";
-    }
-
-
-    /**
-     * returns string like: '</tag>
-     *
-     * @return string
-     */
-    protected function _closing_tag(): string
-    {
-        return "</$this->_tag>";
-    }
-
-
-    /**
-     * returns string like: '/>'
-     *
-     * @return string
-     */
-    protected function _close_tag(): string
-    {
-        return '/>';
-    }
-
-
-    /**
-     * returns an array of standard HTML attributes that get added to nearly all inputs,
-     * where string keys represent named attributes like id, class, etc
-     * and numeric keys represent single attributes like 'required'.
-     * Note: this does not include "value" because many inputs (like dropdowns, textareas, and checkboxes) don't use
-     * it.
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function _standard_attributes_array(): array
-    {
-        return [
-            'name'  => $this->_input->html_name(),
-            'id'    => $this->_input->html_id(),
-            'class' => $this->_input->html_class(true),
-            0       => ['required', $this->_input->required()],
-            1       => $this->_input->other_html_attributes(),
-            'style' => $this->_input->html_style(),
-        ];
-    }
-
-
-    /**
-     * sets the attributes using the incoming array
-     * and returns a string of all attributes rendered as valid HTML
-     *
-     * @param array $attributes
-     * @return string
-     */
-    protected function _attributes_string(array $attributes = []): string
-    {
-        $attributes        = apply_filters(
-            'FHEE__EE_Display_Strategy_Base__attributes_string__attributes',
-            $attributes,
-            $this,
-            $this->_input
-        );
-        $attributes_string = '';
-        foreach ($attributes as $attribute => $value) {
-            if ($attribute !== 'value' && empty($value)) {
-                continue;
-            }
-            if (is_numeric($attribute)) {
-                $add = true;
-                if (is_array($value)) {
-                    $attribute = $value[0] ?? '';
-                    $add       = $value[1] ?? false;
-                } else {
-                    $attribute = $value;
-                }
-                $attributes_string .= $this->_single_attribute($attribute, $add);
-            } else {
-                $attributes_string .= $this->_attribute($attribute, $value);
-            }
-        }
-        return $attributes_string;
-    }
-
-
-    /**
-     * returns string like: ' attribute="value"'
-     * returns an empty string if $value is null
-     *
-     * @param string $attribute
-     * @param string $value
-     * @return string
-     */
-    protected function _attribute(string $attribute, string $value = ''): string
-    {
-        if ($value === null) {
-            return '';
-        }
-        $value = esc_attr($value);
-        return " $attribute=\"$value\"";
-    }
-
-
-    /**
-     * returns string like: ' data-attribute="value"'
-     * returns an empty string if $value is null
-     *
-     * @param string $attribute
-     * @param string $value
-     * @return string
-     */
-    protected function _data_attribute(string $attribute, string $value = ''): string
-    {
-        if ($value === null) {
-            return '';
-        }
-        $value = esc_attr($value);
-        return " data-$attribute=\"$value\"";
-    }
-
-
-    /**
-     * returns string like: ' attribute' if $add is true
-     *
-     * @param string  $attribute
-     * @param boolean $add
-     * @return string
-     */
-    protected function _single_attribute(string $attribute, bool $add = true): string
-    {
-        return $add
-            ? " $attribute"
-            : '';
-    }
+	/**
+	 * @var string $_tag
+	 */
+	protected string $_tag = '';
+
+
+	/**
+	 * returns HTML and javascript related to the displaying of this input
+	 *
+	 * @return string
+	 */
+	abstract public function display(): string;
+
+
+	/**
+	 * _remove_chars - takes an incoming string, and removes the string $chars from the end of it, but only if $chars
+	 * is already there
+	 *
+	 * @param string $string - the string being processed
+	 * @param string $chars  - exact string of characters to remove
+	 * @return string
+	 */
+	protected function _remove_chars(string $string = '', string $chars = '-'): string
+	{
+		$char_length = strlen($chars) * -1;
+		// if last three characters of string is  " - ", then remove it
+		return substr($string, $char_length) === $chars
+			? substr($string, 0, $char_length)
+			: $string;
+	}
+
+
+	/**
+	 * _append_chars - takes an incoming string, and adds the string $chars to the end of it, but only if $chars is not
+	 * already there
+	 *
+	 * @param string $string - the string being processed
+	 * @param string $chars  - exact string of characters to be added to end of string
+	 * @return string
+	 */
+	protected function _append_chars(string $string = '', string $chars = '-'): string
+	{
+		return $this->_remove_chars($string, $chars) . $chars;
+	}
+
+
+	/**
+	 * Gets the HTML IDs of all the inputs
+	 *
+	 * @param bool $add_pound_sign
+	 * @return array
+	 * @throws EE_Error
+	 */
+	public function get_html_input_ids(bool $add_pound_sign = false): array
+	{
+		return [$this->get_input()->html_id($add_pound_sign)];
+	}
+
+
+	/**
+	 * Adds js variables for localization to the $other_js_data. These should be put
+	 * in each form's "other_data" javascript object.
+	 *
+	 * @param array $other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data(array $other_js_data = []): array
+	{
+		return $other_js_data;
+	}
+
+
+	/**
+	 * Opportunity for this display strategy to call wp_enqueue_script and wp_enqueue_style.
+	 * This should be called during wp_enqueue_scripts
+	 */
+	public function enqueue_js()
+	{
+	}
+
+
+	/**
+	 * returns string like: '<tag'
+	 *
+	 * @param string $tag
+	 * @return string
+	 */
+	protected function _opening_tag(string $tag): string
+	{
+		$this->_tag = $tag;
+		return "<$this->_tag";
+	}
+
+
+	/**
+	 * returns string like: '</tag>
+	 *
+	 * @return string
+	 */
+	protected function _closing_tag(): string
+	{
+		return "</$this->_tag>";
+	}
+
+
+	/**
+	 * returns string like: '/>'
+	 *
+	 * @return string
+	 */
+	protected function _close_tag(): string
+	{
+		return '/>';
+	}
+
+
+	/**
+	 * returns an array of standard HTML attributes that get added to nearly all inputs,
+	 * where string keys represent named attributes like id, class, etc
+	 * and numeric keys represent single attributes like 'required'.
+	 * Note: this does not include "value" because many inputs (like dropdowns, textareas, and checkboxes) don't use
+	 * it.
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function _standard_attributes_array(): array
+	{
+		return [
+			'name'  => $this->_input->html_name(),
+			'id'    => $this->_input->html_id(),
+			'class' => $this->_input->html_class(true),
+			0       => ['required', $this->_input->required()],
+			1       => $this->_input->other_html_attributes(),
+			'style' => $this->_input->html_style(),
+		];
+	}
+
+
+	/**
+	 * sets the attributes using the incoming array
+	 * and returns a string of all attributes rendered as valid HTML
+	 *
+	 * @param array $attributes
+	 * @return string
+	 */
+	protected function _attributes_string(array $attributes = []): string
+	{
+		$attributes        = apply_filters(
+			'FHEE__EE_Display_Strategy_Base__attributes_string__attributes',
+			$attributes,
+			$this,
+			$this->_input
+		);
+		$attributes_string = '';
+		foreach ($attributes as $attribute => $value) {
+			if ($attribute !== 'value' && empty($value)) {
+				continue;
+			}
+			if (is_numeric($attribute)) {
+				$add = true;
+				if (is_array($value)) {
+					$attribute = $value[0] ?? '';
+					$add       = $value[1] ?? false;
+				} else {
+					$attribute = $value;
+				}
+				$attributes_string .= $this->_single_attribute($attribute, $add);
+			} else {
+				$attributes_string .= $this->_attribute($attribute, $value);
+			}
+		}
+		return $attributes_string;
+	}
+
+
+	/**
+	 * returns string like: ' attribute="value"'
+	 * returns an empty string if $value is null
+	 *
+	 * @param string $attribute
+	 * @param string $value
+	 * @return string
+	 */
+	protected function _attribute(string $attribute, string $value = ''): string
+	{
+		if ($value === null) {
+			return '';
+		}
+		$value = esc_attr($value);
+		return " $attribute=\"$value\"";
+	}
+
+
+	/**
+	 * returns string like: ' data-attribute="value"'
+	 * returns an empty string if $value is null
+	 *
+	 * @param string $attribute
+	 * @param string $value
+	 * @return string
+	 */
+	protected function _data_attribute(string $attribute, string $value = ''): string
+	{
+		if ($value === null) {
+			return '';
+		}
+		$value = esc_attr($value);
+		return " data-$attribute=\"$value\"";
+	}
+
+
+	/**
+	 * returns string like: ' attribute' if $add is true
+	 *
+	 * @param string  $attribute
+	 * @param boolean $add
+	 * @return string
+	 */
+	protected function _single_attribute(string $attribute, bool $add = true): string
+	{
+		return $add
+			? " $attribute"
+			: '';
+	}
 }

core/libraries/form_sections/strategies/display/EE_Select_Display_Strategy.strategy.php

Indentation +72 added lines, -72 removed lines

@@ -10,83 +10,83 @@
  */
 class EE_Select_Display_Strategy extends EE_Display_Strategy_Base
 {
-    /**
-     * @return string of html to display the field
-     * @throws EE_Error
-     */
-    public function display(): string
-    {
-        if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
-            throw new EE_Error(
-                esc_html__(
-                    'Cannot use Select Display Strategy with an input that doesn\'t have options',
-                    'event_espresso'
-                )
-            );
-        }
+	/**
+	 * @return string of html to display the field
+	 * @throws EE_Error
+	 */
+	public function display(): string
+	{
+		if (! $this->_input instanceof EE_Form_Input_With_Options_Base) {
+			throw new EE_Error(
+				esc_html__(
+					'Cannot use Select Display Strategy with an input that doesn\'t have options',
+					'event_espresso'
+				)
+			);
+		}
 
-        $html = EEH_HTML::nl(0, 'select');
-        $html .= '<select';
-        $html .= $this->_attributes_string(
-            $this->_standard_attributes_array()
-        );
-        $html .= '>';
+		$html = EEH_HTML::nl(0, 'select');
+		$html .= '<select';
+		$html .= $this->_attributes_string(
+			$this->_standard_attributes_array()
+		);
+		$html .= '>';
 
-        if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
-            EEH_HTML::indent(1, 'optgroup');
-            foreach ($this->_input->options() as $opt_group_label => $opt_group) {
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
-                }
-                EEH_HTML::indent(1, 'option');
-                $html .= $this->_display_options($opt_group);
-                EEH_HTML::indent(-1, 'option');
-                if (! empty($opt_group_label)) {
-                    $html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
-                }
-            }
-            EEH_HTML::indent(-1, 'optgroup');
-        } else {
-            $html .= $this->_display_options($this->_input->options());
-        }
+		if (EEH_Array::is_multi_dimensional_array($this->_input->options())) {
+			EEH_HTML::indent(1, 'optgroup');
+			foreach ($this->_input->options() as $opt_group_label => $opt_group) {
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '<optgroup label="' . esc_attr($opt_group_label) . '">';
+				}
+				EEH_HTML::indent(1, 'option');
+				$html .= $this->_display_options($opt_group);
+				EEH_HTML::indent(-1, 'option');
+				if (! empty($opt_group_label)) {
+					$html .= EEH_HTML::nl(0, 'optgroup') . '</optgroup>';
+				}
+			}
+			EEH_HTML::indent(-1, 'optgroup');
+		} else {
+			$html .= $this->_display_options($this->_input->options());
+		}
 
-        $html .= EEH_HTML::nl(0, 'select') . '</select>';
-        return $html;
-    }
+		$html .= EEH_HTML::nl(0, 'select') . '</select>';
+		return $html;
+	}
 
 
-    /**
-     * Displays a flat list of options as option tags
-     *
-     * @param array $options
-     * @return string
-     */
-    protected function _display_options(array $options): string
-    {
-        $html = '';
-        EEH_HTML::indent(1, 'option');
-        foreach ($options as $value => $display_text) {
-            // even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
-            // PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
-            $value    = $this->_input->get_normalization_strategy()->unnormalize_one($value);
-            $selected = $this->_check_if_option_selected($value) ? ' selected' : '';
-            $value    = esc_attr($value);
-            $html     .= EEH_HTML::nl(0, 'option');
-            $html     .= "<option value=\"$value\"$selected>$display_text</option>";
-        }
-        EEH_HTML::indent(-1, 'option');
-        return $html;
-    }
+	/**
+	 * Displays a flat list of options as option tags
+	 *
+	 * @param array $options
+	 * @return string
+	 */
+	protected function _display_options(array $options): string
+	{
+		$html = '';
+		EEH_HTML::indent(1, 'option');
+		foreach ($options as $value => $display_text) {
+			// even if this input uses EE_Text_Normalization if one of the array keys is a numeric string, like "123",
+			// PHP will have converted it to a PHP integer (eg 123). So we need to make sure it's a string
+			$value    = $this->_input->get_normalization_strategy()->unnormalize_one($value);
+			$selected = $this->_check_if_option_selected($value) ? ' selected' : '';
+			$value    = esc_attr($value);
+			$html     .= EEH_HTML::nl(0, 'option');
+			$html     .= "<option value=\"$value\"$selected>$display_text</option>";
+		}
+		EEH_HTML::indent(-1, 'option');
+		return $html;
+	}
 
 
-    /**
-     * Checks if that value is the one selected
-     *
-     * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
-     * @return bool
-     */
-    protected function _check_if_option_selected($option_value): bool
-    {
-        return $option_value === $this->_input->raw_value();
-    }
+	/**
+	 * Checks if that value is the one selected
+	 *
+	 * @param string|int $option_value unnormalized value option (string). How it will appear in the HTML.
+	 * @return bool
+	 */
+	protected function _check_if_option_selected($option_value): bool
+	{
+		return $option_value === $this->_input->raw_value();
+	}
 }

core/libraries/form_sections/strategies/validation/EE_Plaintext_Validation_Strategy.strategy.php

Indentation +23 added lines, -23 removed lines

@@ -13,28 +13,28 @@
  */
 class EE_Plaintext_Validation_Strategy extends EE_Validation_Strategy_Base
 {
-    /**
-     * @param null $validation_error_message
-     */
-    public function __construct($validation_error_message = null)
-    {
-        if (! $validation_error_message) {
-            $validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
-        }
-        parent::__construct($validation_error_message);
-    }
+	/**
+	 * @param null $validation_error_message
+	 */
+	public function __construct($validation_error_message = null)
+	{
+		if (! $validation_error_message) {
+			$validation_error_message = esc_html__("HTML tags are not permitted in this field", "event_espresso");
+		}
+		parent::__construct($validation_error_message);
+	}
 
-    /**
-     * @param string|null $normalized_value
-     * @throws EE_Validation_Error
-     */
-    public function validate($normalized_value = '')
-    {
-        $normalized_value = (string) $normalized_value;
-        $no_tags = wp_strip_all_tags($normalized_value);
-        if (strlen($no_tags) < strlen(trim($normalized_value))) {
-            throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
-        }
-        parent::validate($normalized_value);
-    }
+	/**
+	 * @param string|null $normalized_value
+	 * @throws EE_Validation_Error
+	 */
+	public function validate($normalized_value = '')
+	{
+		$normalized_value = (string) $normalized_value;
+		$no_tags = wp_strip_all_tags($normalized_value);
+		if (strlen($no_tags) < strlen(trim($normalized_value))) {
+			throw new EE_Validation_Error($this->get_validation_error_message(), 'no_html_tags');
+		}
+		parent::validate($normalized_value);
+	}
 }

core/libraries/form_sections/inputs/EE_Form_Input_Base.input.php

Indentation +1216 added lines, -1216 removed lines

@@ -14,1220 +14,1220 @@
  */
 abstract class EE_Form_Input_Base extends EE_Form_Section_Validatable
 {
-    /**
-     * the input's name attribute
-     *
-     * @var string
-     */
-    protected $_html_name;
-
-    /**
-     * id for the html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_id;
-
-    /**
-     * class for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_class;
-
-    /**
-     * style for teh html label tag
-     *
-     * @var string
-     */
-    protected $_html_label_style;
-
-    /**
-     * text to be placed in the html label
-     *
-     * @var string
-     */
-    protected $_html_label_text;
-
-    /**
-     * the full html label. If used, all other html_label_* properties are invalid
-     *
-     * @var string
-     */
-    protected $_html_label;
-
-    /**
-     * HTML to use for help text (normally placed below form input), in a span which normally
-     * has a class of 'description'
-     *
-     * @var string
-     */
-    protected $_html_help_text;
-
-    /**
-     * CSS classes for displaying the help span
-     *
-     * @var string
-     */
-    protected $_html_help_class = 'description';
-
-    /**
-     * CSS to put in the style attribute on the help span
-     *
-     * @var string
-     */
-    protected $_html_help_style;
-
-    /**
-     * Stores whether or not this input's response is required.
-     * Because certain styling elements may also want to know that this
-     * input is required etc.
-     *
-     * @var boolean
-     */
-    protected $_required;
-
-    /**
-     * css class added to required inputs
-     *
-     * @var string
-     */
-    protected $_required_css_class = 'ee-required';
-
-    /**
-     * css styles applied to button type inputs
-     *
-     * @var string
-     */
-    protected $_button_css_attributes;
-
-    /**
-     * The raw post data submitted for this
-     * Generally unsafe for usage in client code
-     *
-     * @var mixed string or array
-     */
-    protected $_raw_value;
-
-    /**
-     * Value normalized according to the input's normalization strategy.
-     * The normalization strategy dictates whether this is a string, int, float,
-     * boolean, or array of any of those.
-     *
-     * @var mixed
-     */
-    protected $_normalized_value;
-
-
-    /**
-     * Normalized default value either initially set on the input, or provided by calling
-     * set_default().
-     *
-     * @var mixed
-     */
-    protected $_default;
-
-    /**
-     * Strategy used for displaying this field.
-     * Child classes must use _get_display_strategy to access it.
-     *
-     * @var EE_Display_Strategy_Base
-     */
-    private $_display_strategy;
-
-    /**
-     * Gets all the validation strategies used on this field
-     *
-     * @var EE_Validation_Strategy_Base[]
-     */
-    private $_validation_strategies = [];
-
-    /**
-     * The normalization strategy for this field
-     *
-     * @var EE_Normalization_Strategy_Base
-     */
-    private $_normalization_strategy;
-
-    /**
-     * Strategy for removing sensitive data after we're done with the form input
-     *
-     * @var EE_Sensitive_Data_Removal_Base
-     */
-    protected $_sensitive_data_removal_strategy;
-
-    /**
-     * Whether this input has been disabled or not.
-     * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
-     * (Client-side code that wants to dynamically disable it must also add this hidden input).
-     * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
-     * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
-     * input is again ignored.
-     *
-     * @var boolean
-     */
-    protected $disabled = false;
-
-
-    /**
-     * @param array                         $input_args       {
-     * @type string                         $html_name        the html name for the input
-     * @type string                         $html_label_id    the id attribute to give to the html label tag
-     * @type string                         $html_label_class the class attribute to give to the html label tag
-     * @type string                         $html_label_style the style attribute to give ot teh label tag
-     * @type string                         $html_label_text  the text to put in the label tag
-     * @type string                         $html_label       the full html label. If used,
-     *                                                        all other html_label_* args are invalid
-     * @type string                         $html_help_text   text to put in help element
-     * @type string                         $html_help_style  style attribute to give to teh help element
-     * @type string                         $html_help_class  class attribute to give to the help element
-     * @type string                         $default          default value NORMALIZED (eg, if providing the default
-     *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
-     *                                                        '1' or '0')
-     * @type EE_Display_Strategy_Base       $display          strategy
-     * @type EE_Normalization_Strategy_Base $normalization_strategy
-     * @type EE_Validation_Strategy_Base[]  $validation_strategies
-     * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
-     *                                                        validation strategies, and sets the normalization
-     *                                                        strategy to the Null normalization. This is good when you
-     *                                                        want the input to be totally ignored server-side (like
-     *                                                        when using React.js form inputs)
-     *                                                        }
-     */
-    public function __construct($input_args = [])
-    {
-        $input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
-        // the following properties must be cast as arrays
-        if (isset($input_args['validation_strategies'])) {
-            foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
-                if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
-                }
-            }
-            unset($input_args['validation_strategies']);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_validation_strategies = [];
-        }
-        // loop thru incoming options
-        foreach ($input_args as $key => $value) {
-            // add underscore to $key to match property names
-            $_key = '_' . $key;
-            if (property_exists($this, $_key)) {
-                $this->{$_key} = $value;
-            }
-        }
-        // ensure that "required" is set correctly
-        $this->set_required(
-            $this->_required,
-            $input_args['required_validation_error_message'] ?? null
-        );
-        // $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
-        $this->_display_strategy->_construct_finalize($this);
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            $validation_strategy->_construct_finalize($this);
-        }
-        if (isset($input_args['ignore_input'])) {
-            $this->_normalization_strategy = new EE_Null_Normalization();
-        }
-        if (! $this->_normalization_strategy) {
-            $this->_normalization_strategy = new EE_Text_Normalization();
-        }
-        $this->_normalization_strategy->_construct_finalize($this);
-        // at least we can use the normalization strategy to populate the default
-        if (isset($input_args['default'])) {
-            $this->set_default($input_args['default']);
-            unset($input_args['default']);
-        }
-        if (! $this->_sensitive_data_removal_strategy) {
-            $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
-        }
-        $this->_sensitive_data_removal_strategy->_construct_finalize($this);
-        parent::__construct($input_args);
-    }
-
-
-    /**
-     * Sets the html_name to its default value, if none was specified in teh constructor.
-     * Calculation involves using the name and the parent's html_name
-     *
-     * @throws EE_Error
-     */
-    protected function _set_default_html_name_if_empty()
-    {
-        if (! $this->_html_name) {
-            $this->_html_name = $this->name();
-            if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
-            }
-        }
-    }
-
-
-    /**
-     * @param $parent_form_section
-     * @param $name
-     * @throws EE_Error
-     */
-    public function _construct_finalize($parent_form_section, $name)
-    {
-        parent::_construct_finalize($parent_form_section, $name);
-        if ($this->_html_label === null && $this->_html_label_text === null) {
-            $this->_html_label_text = ucwords(str_replace("_", " ", $name));
-        }
-        do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
-    }
-
-
-    /**
-     * Returns the strategy for displaying this form input. If none is set, throws an exception.
-     *
-     * @return EE_Display_Strategy_Base
-     * @throws EE_Error
-     */
-    protected function _get_display_strategy()
-    {
-        $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
-            throw new EE_Error(
-                sprintf(
-                    esc_html__(
-                        "Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
-                        "event_espresso"
-                    ),
-                    $this->html_name(),
-                    $this->html_id()
-                )
-            );
-        } else {
-            return $this->_display_strategy;
-        }
-    }
-
-
-    /**
-     * Sets the display strategy.
-     *
-     * @param EE_Display_Strategy_Base $strategy
-     */
-    protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
-    {
-        $this->_display_strategy = $strategy;
-    }
-
-
-    /**
-     * Sets the sanitization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $strategy
-     */
-    protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
-    {
-        $this->_normalization_strategy = $strategy;
-    }
-
-
-    /**
-     * Gets sensitive_data_removal_strategy
-     *
-     * @return EE_Sensitive_Data_Removal_Base
-     */
-    public function get_sensitive_data_removal_strategy()
-    {
-        return $this->_sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Sets sensitive_data_removal_strategy
-     *
-     * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
-     * @return void
-     */
-    public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
-    {
-        $this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
-    }
-
-
-    /**
-     * Gets the display strategy for this input
-     *
-     * @return EE_Display_Strategy_Base
-     */
-    public function get_display_strategy()
-    {
-        return $this->_display_strategy;
-    }
-
-
-    /**
-     * Overwrites the display strategy
-     *
-     * @param EE_Display_Strategy_Base $display_strategy
-     */
-    public function set_display_strategy($display_strategy)
-    {
-        $this->_display_strategy = $display_strategy;
-        $this->_display_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Gets the normalization strategy set on this input
-     *
-     * @return EE_Normalization_Strategy_Base
-     */
-    public function get_normalization_strategy()
-    {
-        return $this->_normalization_strategy;
-    }
-
-
-    /**
-     * Overwrites the normalization strategy
-     *
-     * @param EE_Normalization_Strategy_Base $normalization_strategy
-     */
-    public function set_normalization_strategy($normalization_strategy)
-    {
-        $this->_normalization_strategy = $normalization_strategy;
-        $this->_normalization_strategy->_construct_finalize($this);
-    }
-
-
-    /**
-     * Returns all teh validation strategies which apply to this field, numerically indexed
-     *
-     * @return EE_Validation_Strategy_Base[]
-     */
-    public function get_validation_strategies()
-    {
-        return $this->_validation_strategies;
-    }
-
-
-    /**
-     * Adds this strategy to the field so it will be used in both JS validation and server-side validation
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $validation_strategy->_construct_finalize($this);
-        $this->_validation_strategies[] = $validation_strategy;
-    }
-
-
-    /**
-     * Adds a new validation strategy onto the form input
-     *
-     * @param EE_Validation_Strategy_Base $validation_strategy
-     * @return void
-     */
-    public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
-    {
-        $this->_add_validation_strategy($validation_strategy);
-    }
-
-
-    /**
-     * The classname of the validation strategy to remove
-     *
-     * @param string $validation_strategy_classname
-     */
-    public function remove_validation_strategy($validation_strategy_classname)
-    {
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (
-                $validation_strategy instanceof $validation_strategy_classname
-                || is_subclass_of($validation_strategy, $validation_strategy_classname)
-            ) {
-                unset($this->_validation_strategies[ $key ]);
-            }
-        }
-    }
-
-
-    /**
-     * returns true if input employs any of the validation strategy defined by the supplied array of classnames
-     *
-     * @param array $validation_strategy_classnames
-     * @return bool
-     */
-    public function has_validation_strategy($validation_strategy_classnames)
-    {
-        $validation_strategy_classnames = is_array($validation_strategy_classnames)
-            ? $validation_strategy_classnames
-            : [$validation_strategy_classnames];
-        foreach ($this->_validation_strategies as $key => $validation_strategy) {
-            if (in_array($key, $validation_strategy_classnames)) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-
-    /**
-     * Gets the HTML
-     *
-     * @return string
-     */
-    public function get_html()
-    {
-        return $this->_parent_section->get_html_for_input($this);
-    }
-
-
-    /**
-     * Gets the HTML for the input itself (no label or errors) according to the
-     * input's display strategy
-     * Makes sure the JS and CSS are enqueued for it
-     *
-     * @return string
-     * @throws EE_Error
-     */
-    public function get_html_for_input()
-    {
-        return $this->_form_html_filter
-            ? $this->_form_html_filter->filterHtml(
-                $this->_get_display_strategy()->display(),
-                $this
-            )
-            : $this->_get_display_strategy()->display();
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_other_attributes()
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        return $this->other_html_attributes();
-    }
-
-
-    /**
-     * @param string $html_other_attributes
-     */
-    public function set_html_other_attributes($html_other_attributes)
-    {
-        EE_Error::doing_it_wrong(
-            __METHOD__,
-            sprintf(
-                esc_html__(
-                    'This method is no longer in use. You should replace it by %s',
-                    'event_espresso'
-                ),
-                'EE_Form_Section_Base::set_other_html_attributes()'
-            ),
-            '4.10.2.p'
-        );
-
-        $this->set_other_html_attributes($html_other_attributes);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the label for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_label()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_label($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the errors section for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_errors()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_errors($this);
-    }
-
-
-    /**
-     * Gets the HTML for displaying the help text for this form input
-     * according to the form section's layout strategy
-     *
-     * @return string
-     */
-    public function get_html_for_help()
-    {
-        return $this->_parent_section->get_layout_strategy()->display_help_text($this);
-    }
-
-
-    /**
-     * Validates the input's sanitized value (assumes _sanitize() has already been called)
-     * and returns whether or not the form input's submitted value is value
-     *
-     * @return boolean
-     */
-    protected function _validate()
-    {
-        if ($this->isDisabled()) {
-            return true;
-        }
-        foreach ($this->_validation_strategies as $validation_strategy) {
-            if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
-                try {
-                    $validation_strategy->validate($this->normalized_value());
-                } catch (EE_Validation_Error $e) {
-                    $this->add_validation_error($e);
-                }
-            }
-        }
-        if ($this->get_validation_errors()) {
-            return false;
-        } else {
-            return true;
-        }
-    }
-
-
-    /**
-     * Performs basic sanitization on this value. But what sanitization can be performed anyways?
-     * This value MIGHT be allowed to have tags, so we can't really remove them.
-     *
-     * @param string $value
-     * @return null|string
-     */
-    protected function _sanitize($value)
-    {
-        return $value !== null
-            ? stripslashes(html_entity_decode(trim((string) $value)))
-            : null;
-    }
-
-
-    /**
-     * Picks out the form value that relates to this form input,
-     * and stores it as the sanitized value on the form input, and sets the normalized value.
-     * Returns whether or not any validation errors occurred
-     *
-     * @param array $req_data
-     * @return boolean whether or not there was an error
-     * @throws EE_Error
-     */
-    protected function _normalize($req_data)
-    {
-        // any existing validation errors don't apply so clear them
-        $this->_validation_errors = [];
-        // if the input is disabled, ignore whatever input was sent in
-        if ($this->isDisabled()) {
-            $this->_set_raw_value(null);
-            $this->_set_normalized_value($this->get_default());
-            return false;
-        }
-        try {
-            $raw_input = $this->find_form_data_for_this_section($req_data);
-            // super simple sanitization for now
-            if (is_array($raw_input)) {
-                $raw_value = [];
-                foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
-                }
-                $this->_set_raw_value($raw_value);
-            } else {
-                $this->_set_raw_value($this->_sanitize($raw_input));
-            }
-            // we want to mostly leave the input alone in case we need to re-display it to the user
-            $this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
-            return false;
-        } catch (EE_Validation_Error $e) {
-            $this->add_validation_error($e);
-            return true;
-        }
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_name()
-    {
-        $this->_set_default_html_name_if_empty();
-        return $this->_html_name ?? '';
-    }
-
-
-    /**
-     * @return string
-     * @throws EE_Error
-     */
-    public function html_label_id()
-    {
-        return ! empty($this->_html_label_id)
-            ? $this->_html_label_id
-            : $this->html_id() . '-lbl';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_class()
-    {
-        return $this->_html_label_class ?? '';
-    }
-
-
-    /**
-     * @param string $html_class
-     */
-    public function add_html_label_class(string $html_class)
-    {
-        $this->_html_label_class .= ' ' . trim($html_class);
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_style()
-    {
-        return $this->_html_label_style ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_label_text()
-    {
-        return $this->_html_label_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_text()
-    {
-        return $this->_html_help_text ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_class()
-    {
-        return $this->_html_help_class ?? '';
-    }
-
-
-    /**
-     * @return string
-     */
-    public function html_help_style()
-    {
-        return $this->_html_style ?? '';
-    }
-
-
-    /**
-     * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
-     * Please note that almost all client code should instead use the normalized_value;
-     * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
-     * mostly by escaping quotes)
-     * Note, we do not store the exact original value sent in the user's request because
-     * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
-     * in which case, we would have stored the malicious content to our database.
-     *
-     * @return mixed
-     */
-    public function raw_value()
-    {
-        return $this->_raw_value;
-    }
-
-
-    /**
-     * Returns a string safe to usage in form inputs when displaying, because
-     * it escapes all html entities
-     *
-     * @return string
-     */
-    public function raw_value_in_form(): string
-    {
-        return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
-    }
-
-
-    /**
-     * returns the value after it's been sanitized, and then converted into it's proper type
-     * in PHP. Eg, a string, an int, an array,
-     *
-     * @return mixed
-     */
-    public function normalized_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * Returns the normalized value is a presentable way. By default this is just
-     * the normalized value by itself, but it can be overridden for when that's not
-     * the best thing to display
-     *
-     * @return mixed
-     */
-    public function pretty_value()
-    {
-        return $this->_normalized_value;
-    }
-
-
-    /**
-     * When generating the JS for the jquery validation rules like<br>
-     * <code>$( "#myform" ).validate({
-     * rules: {
-     * password: "required",
-     * password_again: {
-     * equalTo: "#password"
-     * }
-     * }
-     * });</code>
-     * if this field had the name 'password_again', it should return
-     * <br><code>password_again: {
-     * equalTo: "#password"
-     * }</code>
-     *
-     * @return array
-     */
-    public function get_jquery_validation_rules(): array
-    {
-        $jquery_validation_js    = [];
-        $jquery_validation_rules = [];
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $jquery_validation_rules = array_replace_recursive(
-                $jquery_validation_rules,
-                $validation_strategy->get_jquery_validation_rule_array()
-            );
-        }
-        if (! empty($jquery_validation_rules)) {
-            foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
-            }
-        }
-        return $jquery_validation_js;
-    }
-
-
-    /**
-     * Sets the input's default value for use in displaying in the form. Note: value should be
-     * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
-     *
-     * @param mixed $value
-     * @return void
-     */
-    public function set_default($value)
-    {
-        $this->_default = $value;
-        $this->_set_normalized_value($value);
-        $this->_set_raw_value($value);
-    }
-
-
-    /**
-     * Sets the normalized value on this input
-     *
-     * @param mixed $value
-     */
-    protected function _set_normalized_value($value)
-    {
-        $this->_normalized_value = $value;
-    }
-
-
-    /**
-     * Sets the raw value on this input (ie, exactly as the user submitted it)
-     *
-     * @param mixed $value
-     */
-    protected function _set_raw_value($value)
-    {
-        $this->_raw_value = $this->_normalization_strategy->unnormalize($value);
-    }
-
-
-    /**
-     * Sets the HTML label text after it has already been defined
-     *
-     * @param string $label
-     * @return void
-     */
-    public function set_html_label_text($label)
-    {
-        $this->_html_label_text = $label;
-    }
-
-
-    /**
-     * Sets whether or not this field is required, and adjusts the validation strategy.
-     * If you want to use the EE_Conditionally_Required_Validation_Strategy,
-     * please add it as a validation strategy using add_validation_strategy as normal
-     *
-     * @param boolean $required boolean
-     * @param null    $required_text
-     */
-    public function set_required($required = true, $required_text = null)
-    {
-        $required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
-        // whether $required is a string or a boolean, we want to add a required validation strategy
-        if ($required) {
-            $this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
-        } else {
-            $this->remove_validation_strategy('EE_Required_Validation_Strategy');
-        }
-        $this->_required = $required;
-    }
-
-
-    /**
-     * Returns whether or not this field is required
-     *
-     * @return boolean
-     */
-    public function required()
-    {
-        return $this->_required;
-    }
-
-
-    /**
-     * @param string $required_css_class
-     */
-    public function set_required_css_class($required_css_class)
-    {
-        $this->_required_css_class = $required_css_class;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function required_css_class()
-    {
-        return $this->_required_css_class;
-    }
-
-
-    /**
-     * @param bool $add_required
-     * @return string
-     */
-    public function html_class($add_required = false)
-    {
-        return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
-            : $this->_html_class;
-    }
-
-
-    /**
-     * Sets the help text, in case
-     *
-     * @param string $text
-     */
-    public function set_html_help_text($text)
-    {
-        $this->_html_help_text = $text;
-    }
-
-
-    /**
-     * Uses the sensitive data removal strategy to remove the sensitive data from this
-     * input. If there is any kind of sensitive data removal on this input, we clear
-     * out the raw value completely
-     *
-     * @return void
-     */
-    public function clean_sensitive_data()
-    {
-        // if we do ANY kind of sensitive data removal on this, then just clear out the raw value
-        // if we need more logic than this we'll make a strategy for it
-        if (
-            $this->_sensitive_data_removal_strategy
-            && ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
-        ) {
-            $this->_set_raw_value(null);
-        }
-        // and clean the normalized value according to the appropriate strategy
-        $this->_set_normalized_value(
-            $this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
-                $this->_normalized_value
-            )
-        );
-    }
-
-
-    /**
-     * @param bool   $primary
-     * @param string $button_size
-     * @param string $other_attributes
-     */
-    public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
-    {
-        $button_css_attributes = 'button';
-        $button_css_attributes .= $primary === true
-            ? ' button--primary'
-            : ' button--secondary';
-        switch ($button_size) {
-            case 'xs':
-            case 'extra-small':
-                $button_css_attributes .= ' button-xs';
-                break;
-            case 'sm':
-            case 'small':
-                $button_css_attributes .= ' button-sm';
-                break;
-            case 'lg':
-            case 'large':
-                $button_css_attributes .= ' button-lg';
-                break;
-            case 'block':
-                $button_css_attributes .= ' button-block';
-                break;
-            case 'md':
-            case 'medium':
-            default:
-                $button_css_attributes .= '';
-        }
-        $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
-            : $button_css_attributes;
-    }
-
-
-    /**
-     * @return string
-     */
-    public function button_css_attributes()
-    {
-        if (empty($this->_button_css_attributes)) {
-            $this->set_button_css_attributes();
-        }
-        return $this->_button_css_attributes;
-    }
-
-
-    /**
-     * find_form_data_for_this_section
-     * using this section's name and its parents, finds the value of the form data that corresponds to it.
-     * For example, if this form section's HTML name is my_form[subform][form_input_1],
-     * then it's value should be in request at request['my_form']['subform']['form_input_1'].
-     * (If that doesn't exist, we also check for this subsection's name
-     * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
-     * This function finds its value in the form.
-     *
-     * @param array $req_data
-     * @return mixed whatever the raw value of this form section is in the request data
-     * @throws EE_Error
-     */
-    public function find_form_data_for_this_section($req_data)
-    {
-        $name_parts = $this->getInputNameParts();
-        // now get the value for the input
-        $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
-        // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
-        }
-        return $value;
-    }
-
-
-    /**
-     * If this input's name is something like "foo[bar][baz]"
-     * returns an array like `array('foo','bar',baz')`
-     *
-     * @return array
-     * @throws EE_Error
-     */
-    protected function getInputNameParts()
-    {
-        // break up the html name by "[]"
-        if (strpos($this->html_name(), '[') !== false) {
-            $before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
-        } else {
-            $before_any_brackets = $this->html_name();
-        }
-        // grab all of the segments
-        preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
-        if (isset($matches[1]) && is_array($matches[1])) {
-            $name_parts = $matches[1];
-            array_unshift($name_parts, $before_any_brackets);
-        } else {
-            $name_parts = [$before_any_brackets];
-        }
-        return $name_parts;
-    }
-
-
-    /**
-     * @param array $html_name_parts
-     * @param array $req_data
-     * @return array | NULL
-     */
-    public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
-    {
-        $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
-            if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
-            } else {
-                return $this->findRequestForSectionUsingNameParts(
-                    $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
-                );
-            }
-        } else {
-            return null;
-        }
-    }
-
-
-    /**
-     * Checks if this form input's data is in the request data
-     *
-     * @param array $req_data
-     * @return boolean
-     * @throws EE_Error
-     */
-    public function form_data_present_in($req_data = null)
-    {
-        if ($req_data === null) {
-            /** @var RequestInterface $request */
-            $request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
-            $req_data = $request->postParams();
-        }
-        $checked_value = $this->find_form_data_for_this_section($req_data);
-        if ($checked_value !== null) {
-            return true;
-        } else {
-            return false;
-        }
-    }
-
-
-    /**
-     * Overrides parent to add js data from validation and display strategies
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data($form_other_js_data = [])
-    {
-        return $this->get_other_js_data_from_strategies($form_other_js_data);
-    }
-
-
-    /**
-     * Gets other JS data for localization from this input's strategies, like
-     * the validation strategies and the display strategy
-     *
-     * @param array $form_other_js_data
-     * @return array
-     */
-    public function get_other_js_data_from_strategies($form_other_js_data = [])
-    {
-        $form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
-        }
-        return $form_other_js_data;
-    }
-
-
-    /**
-     * Override parent because we want to give our strategies an opportunity to enqueue some js and css
-     *
-     * @return void
-     */
-    public function enqueue_js()
-    {
-        // ask our display strategy and validation strategies if they have js to enqueue
-        $this->enqueue_js_from_strategies();
-    }
-
-
-    /**
-     * Tells strategies when its ok to enqueue their js and css
-     *
-     * @return void
-     */
-    public function enqueue_js_from_strategies()
-    {
-        $this->get_display_strategy()->enqueue_js();
-        foreach ($this->get_validation_strategies() as $validation_strategy) {
-            $validation_strategy->enqueue_js();
-        }
-    }
-
-
-    /**
-     * Gets the default value set on the input (not the current value, which may have been
-     * changed because of a form submission). If no default was set, this us null.
-     *
-     * @return mixed
-     */
-    public function get_default()
-    {
-        return $this->_default;
-    }
-
-
-    /**
-     * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
-     * and server-side if any input was received it will be ignored
-     */
-    public function disable($disable = true)
-    {
-        $disabled_attribute = ' disabled="disabled"';
-        $this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
-        if ($this->disabled) {
-            if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
-                $this->_other_html_attributes .= $disabled_attribute;
-            }
-            $this->_set_normalized_value($this->get_default());
-        } else {
-            $this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
-        }
-    }
-
-
-    /**
-     * Returns whether or not this input is currently disabled.
-     *
-     * @return bool
-     */
-    public function isDisabled()
-    {
-        return $this->disabled;
-    }
+	/**
+	 * the input's name attribute
+	 *
+	 * @var string
+	 */
+	protected $_html_name;
+
+	/**
+	 * id for the html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_id;
+
+	/**
+	 * class for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_class;
+
+	/**
+	 * style for teh html label tag
+	 *
+	 * @var string
+	 */
+	protected $_html_label_style;
+
+	/**
+	 * text to be placed in the html label
+	 *
+	 * @var string
+	 */
+	protected $_html_label_text;
+
+	/**
+	 * the full html label. If used, all other html_label_* properties are invalid
+	 *
+	 * @var string
+	 */
+	protected $_html_label;
+
+	/**
+	 * HTML to use for help text (normally placed below form input), in a span which normally
+	 * has a class of 'description'
+	 *
+	 * @var string
+	 */
+	protected $_html_help_text;
+
+	/**
+	 * CSS classes for displaying the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_class = 'description';
+
+	/**
+	 * CSS to put in the style attribute on the help span
+	 *
+	 * @var string
+	 */
+	protected $_html_help_style;
+
+	/**
+	 * Stores whether or not this input's response is required.
+	 * Because certain styling elements may also want to know that this
+	 * input is required etc.
+	 *
+	 * @var boolean
+	 */
+	protected $_required;
+
+	/**
+	 * css class added to required inputs
+	 *
+	 * @var string
+	 */
+	protected $_required_css_class = 'ee-required';
+
+	/**
+	 * css styles applied to button type inputs
+	 *
+	 * @var string
+	 */
+	protected $_button_css_attributes;
+
+	/**
+	 * The raw post data submitted for this
+	 * Generally unsafe for usage in client code
+	 *
+	 * @var mixed string or array
+	 */
+	protected $_raw_value;
+
+	/**
+	 * Value normalized according to the input's normalization strategy.
+	 * The normalization strategy dictates whether this is a string, int, float,
+	 * boolean, or array of any of those.
+	 *
+	 * @var mixed
+	 */
+	protected $_normalized_value;
+
+
+	/**
+	 * Normalized default value either initially set on the input, or provided by calling
+	 * set_default().
+	 *
+	 * @var mixed
+	 */
+	protected $_default;
+
+	/**
+	 * Strategy used for displaying this field.
+	 * Child classes must use _get_display_strategy to access it.
+	 *
+	 * @var EE_Display_Strategy_Base
+	 */
+	private $_display_strategy;
+
+	/**
+	 * Gets all the validation strategies used on this field
+	 *
+	 * @var EE_Validation_Strategy_Base[]
+	 */
+	private $_validation_strategies = [];
+
+	/**
+	 * The normalization strategy for this field
+	 *
+	 * @var EE_Normalization_Strategy_Base
+	 */
+	private $_normalization_strategy;
+
+	/**
+	 * Strategy for removing sensitive data after we're done with the form input
+	 *
+	 * @var EE_Sensitive_Data_Removal_Base
+	 */
+	protected $_sensitive_data_removal_strategy;
+
+	/**
+	 * Whether this input has been disabled or not.
+	 * If it's disabled while rendering, an extra hidden input is added that indicates it has been knowingly disabled.
+	 * (Client-side code that wants to dynamically disable it must also add this hidden input).
+	 * When the form is submitted, if the input is disabled in the PHP form section, then input is ignored.
+	 * If the input is missing from the request data but the hidden input indicating the input is disabled, then the
+	 * input is again ignored.
+	 *
+	 * @var boolean
+	 */
+	protected $disabled = false;
+
+
+	/**
+	 * @param array                         $input_args       {
+	 * @type string                         $html_name        the html name for the input
+	 * @type string                         $html_label_id    the id attribute to give to the html label tag
+	 * @type string                         $html_label_class the class attribute to give to the html label tag
+	 * @type string                         $html_label_style the style attribute to give ot teh label tag
+	 * @type string                         $html_label_text  the text to put in the label tag
+	 * @type string                         $html_label       the full html label. If used,
+	 *                                                        all other html_label_* args are invalid
+	 * @type string                         $html_help_text   text to put in help element
+	 * @type string                         $html_help_style  style attribute to give to teh help element
+	 * @type string                         $html_help_class  class attribute to give to the help element
+	 * @type string                         $default          default value NORMALIZED (eg, if providing the default
+	 *                                                        for a Yes_No_Input, you should provide TRUE or FALSE, not
+	 *                                                        '1' or '0')
+	 * @type EE_Display_Strategy_Base       $display          strategy
+	 * @type EE_Normalization_Strategy_Base $normalization_strategy
+	 * @type EE_Validation_Strategy_Base[]  $validation_strategies
+	 * @type boolean                        $ignore_input     special argument which can be used to avoid adding any
+	 *                                                        validation strategies, and sets the normalization
+	 *                                                        strategy to the Null normalization. This is good when you
+	 *                                                        want the input to be totally ignored server-side (like
+	 *                                                        when using React.js form inputs)
+	 *                                                        }
+	 */
+	public function __construct($input_args = [])
+	{
+		$input_args = (array) apply_filters('FHEE__EE_Form_Input_Base___construct__input_args', $input_args, $this);
+		// the following properties must be cast as arrays
+		if (isset($input_args['validation_strategies'])) {
+			foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
+				if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
+					$this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+				}
+			}
+			unset($input_args['validation_strategies']);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_validation_strategies = [];
+		}
+		// loop thru incoming options
+		foreach ($input_args as $key => $value) {
+			// add underscore to $key to match property names
+			$_key = '_' . $key;
+			if (property_exists($this, $_key)) {
+				$this->{$_key} = $value;
+			}
+		}
+		// ensure that "required" is set correctly
+		$this->set_required(
+			$this->_required,
+			$input_args['required_validation_error_message'] ?? null
+		);
+		// $this->_html_name_specified = isset( $input_args['html_name'] ) ? TRUE : FALSE;
+		$this->_display_strategy->_construct_finalize($this);
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			$validation_strategy->_construct_finalize($this);
+		}
+		if (isset($input_args['ignore_input'])) {
+			$this->_normalization_strategy = new EE_Null_Normalization();
+		}
+		if (! $this->_normalization_strategy) {
+			$this->_normalization_strategy = new EE_Text_Normalization();
+		}
+		$this->_normalization_strategy->_construct_finalize($this);
+		// at least we can use the normalization strategy to populate the default
+		if (isset($input_args['default'])) {
+			$this->set_default($input_args['default']);
+			unset($input_args['default']);
+		}
+		if (! $this->_sensitive_data_removal_strategy) {
+			$this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
+		}
+		$this->_sensitive_data_removal_strategy->_construct_finalize($this);
+		parent::__construct($input_args);
+	}
+
+
+	/**
+	 * Sets the html_name to its default value, if none was specified in teh constructor.
+	 * Calculation involves using the name and the parent's html_name
+	 *
+	 * @throws EE_Error
+	 */
+	protected function _set_default_html_name_if_empty()
+	{
+		if (! $this->_html_name) {
+			$this->_html_name = $this->name();
+			if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
+				$this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+			}
+		}
+	}
+
+
+	/**
+	 * @param $parent_form_section
+	 * @param $name
+	 * @throws EE_Error
+	 */
+	public function _construct_finalize($parent_form_section, $name)
+	{
+		parent::_construct_finalize($parent_form_section, $name);
+		if ($this->_html_label === null && $this->_html_label_text === null) {
+			$this->_html_label_text = ucwords(str_replace("_", " ", $name));
+		}
+		do_action('AHEE__EE_Form_Input_Base___construct_finalize__end', $this, $parent_form_section, $name);
+	}
+
+
+	/**
+	 * Returns the strategy for displaying this form input. If none is set, throws an exception.
+	 *
+	 * @return EE_Display_Strategy_Base
+	 * @throws EE_Error
+	 */
+	protected function _get_display_strategy()
+	{
+		$this->ensure_construct_finalized_called();
+		if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+			throw new EE_Error(
+				sprintf(
+					esc_html__(
+						"Cannot get display strategy for form input with name %s and id %s, because it has not been set in the constructor",
+						"event_espresso"
+					),
+					$this->html_name(),
+					$this->html_id()
+				)
+			);
+		} else {
+			return $this->_display_strategy;
+		}
+	}
+
+
+	/**
+	 * Sets the display strategy.
+	 *
+	 * @param EE_Display_Strategy_Base $strategy
+	 */
+	protected function _set_display_strategy(EE_Display_Strategy_Base $strategy)
+	{
+		$this->_display_strategy = $strategy;
+	}
+
+
+	/**
+	 * Sets the sanitization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $strategy
+	 */
+	protected function _set_normalization_strategy(EE_Normalization_Strategy_Base $strategy)
+	{
+		$this->_normalization_strategy = $strategy;
+	}
+
+
+	/**
+	 * Gets sensitive_data_removal_strategy
+	 *
+	 * @return EE_Sensitive_Data_Removal_Base
+	 */
+	public function get_sensitive_data_removal_strategy()
+	{
+		return $this->_sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Sets sensitive_data_removal_strategy
+	 *
+	 * @param EE_Sensitive_Data_Removal_Base $sensitive_data_removal_strategy
+	 * @return void
+	 */
+	public function set_sensitive_data_removal_strategy($sensitive_data_removal_strategy)
+	{
+		$this->_sensitive_data_removal_strategy = $sensitive_data_removal_strategy;
+	}
+
+
+	/**
+	 * Gets the display strategy for this input
+	 *
+	 * @return EE_Display_Strategy_Base
+	 */
+	public function get_display_strategy()
+	{
+		return $this->_display_strategy;
+	}
+
+
+	/**
+	 * Overwrites the display strategy
+	 *
+	 * @param EE_Display_Strategy_Base $display_strategy
+	 */
+	public function set_display_strategy($display_strategy)
+	{
+		$this->_display_strategy = $display_strategy;
+		$this->_display_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Gets the normalization strategy set on this input
+	 *
+	 * @return EE_Normalization_Strategy_Base
+	 */
+	public function get_normalization_strategy()
+	{
+		return $this->_normalization_strategy;
+	}
+
+
+	/**
+	 * Overwrites the normalization strategy
+	 *
+	 * @param EE_Normalization_Strategy_Base $normalization_strategy
+	 */
+	public function set_normalization_strategy($normalization_strategy)
+	{
+		$this->_normalization_strategy = $normalization_strategy;
+		$this->_normalization_strategy->_construct_finalize($this);
+	}
+
+
+	/**
+	 * Returns all teh validation strategies which apply to this field, numerically indexed
+	 *
+	 * @return EE_Validation_Strategy_Base[]
+	 */
+	public function get_validation_strategies()
+	{
+		return $this->_validation_strategies;
+	}
+
+
+	/**
+	 * Adds this strategy to the field so it will be used in both JS validation and server-side validation
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	protected function _add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$validation_strategy->_construct_finalize($this);
+		$this->_validation_strategies[] = $validation_strategy;
+	}
+
+
+	/**
+	 * Adds a new validation strategy onto the form input
+	 *
+	 * @param EE_Validation_Strategy_Base $validation_strategy
+	 * @return void
+	 */
+	public function add_validation_strategy(EE_Validation_Strategy_Base $validation_strategy)
+	{
+		$this->_add_validation_strategy($validation_strategy);
+	}
+
+
+	/**
+	 * The classname of the validation strategy to remove
+	 *
+	 * @param string $validation_strategy_classname
+	 */
+	public function remove_validation_strategy($validation_strategy_classname)
+	{
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (
+				$validation_strategy instanceof $validation_strategy_classname
+				|| is_subclass_of($validation_strategy, $validation_strategy_classname)
+			) {
+				unset($this->_validation_strategies[ $key ]);
+			}
+		}
+	}
+
+
+	/**
+	 * returns true if input employs any of the validation strategy defined by the supplied array of classnames
+	 *
+	 * @param array $validation_strategy_classnames
+	 * @return bool
+	 */
+	public function has_validation_strategy($validation_strategy_classnames)
+	{
+		$validation_strategy_classnames = is_array($validation_strategy_classnames)
+			? $validation_strategy_classnames
+			: [$validation_strategy_classnames];
+		foreach ($this->_validation_strategies as $key => $validation_strategy) {
+			if (in_array($key, $validation_strategy_classnames)) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+
+	/**
+	 * Gets the HTML
+	 *
+	 * @return string
+	 */
+	public function get_html()
+	{
+		return $this->_parent_section->get_html_for_input($this);
+	}
+
+
+	/**
+	 * Gets the HTML for the input itself (no label or errors) according to the
+	 * input's display strategy
+	 * Makes sure the JS and CSS are enqueued for it
+	 *
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function get_html_for_input()
+	{
+		return $this->_form_html_filter
+			? $this->_form_html_filter->filterHtml(
+				$this->_get_display_strategy()->display(),
+				$this
+			)
+			: $this->_get_display_strategy()->display();
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_other_attributes()
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		return $this->other_html_attributes();
+	}
+
+
+	/**
+	 * @param string $html_other_attributes
+	 */
+	public function set_html_other_attributes($html_other_attributes)
+	{
+		EE_Error::doing_it_wrong(
+			__METHOD__,
+			sprintf(
+				esc_html__(
+					'This method is no longer in use. You should replace it by %s',
+					'event_espresso'
+				),
+				'EE_Form_Section_Base::set_other_html_attributes()'
+			),
+			'4.10.2.p'
+		);
+
+		$this->set_other_html_attributes($html_other_attributes);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the label for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_label()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_label($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the errors section for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_errors()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_errors($this);
+	}
+
+
+	/**
+	 * Gets the HTML for displaying the help text for this form input
+	 * according to the form section's layout strategy
+	 *
+	 * @return string
+	 */
+	public function get_html_for_help()
+	{
+		return $this->_parent_section->get_layout_strategy()->display_help_text($this);
+	}
+
+
+	/**
+	 * Validates the input's sanitized value (assumes _sanitize() has already been called)
+	 * and returns whether or not the form input's submitted value is value
+	 *
+	 * @return boolean
+	 */
+	protected function _validate()
+	{
+		if ($this->isDisabled()) {
+			return true;
+		}
+		foreach ($this->_validation_strategies as $validation_strategy) {
+			if ($validation_strategy instanceof EE_Validation_Strategy_Base) {
+				try {
+					$validation_strategy->validate($this->normalized_value());
+				} catch (EE_Validation_Error $e) {
+					$this->add_validation_error($e);
+				}
+			}
+		}
+		if ($this->get_validation_errors()) {
+			return false;
+		} else {
+			return true;
+		}
+	}
+
+
+	/**
+	 * Performs basic sanitization on this value. But what sanitization can be performed anyways?
+	 * This value MIGHT be allowed to have tags, so we can't really remove them.
+	 *
+	 * @param string $value
+	 * @return null|string
+	 */
+	protected function _sanitize($value)
+	{
+		return $value !== null
+			? stripslashes(html_entity_decode(trim((string) $value)))
+			: null;
+	}
+
+
+	/**
+	 * Picks out the form value that relates to this form input,
+	 * and stores it as the sanitized value on the form input, and sets the normalized value.
+	 * Returns whether or not any validation errors occurred
+	 *
+	 * @param array $req_data
+	 * @return boolean whether or not there was an error
+	 * @throws EE_Error
+	 */
+	protected function _normalize($req_data)
+	{
+		// any existing validation errors don't apply so clear them
+		$this->_validation_errors = [];
+		// if the input is disabled, ignore whatever input was sent in
+		if ($this->isDisabled()) {
+			$this->_set_raw_value(null);
+			$this->_set_normalized_value($this->get_default());
+			return false;
+		}
+		try {
+			$raw_input = $this->find_form_data_for_this_section($req_data);
+			// super simple sanitization for now
+			if (is_array($raw_input)) {
+				$raw_value = [];
+				foreach ($raw_input as $key => $value) {
+					$raw_value[ $key ] = $this->_sanitize($value);
+				}
+				$this->_set_raw_value($raw_value);
+			} else {
+				$this->_set_raw_value($this->_sanitize($raw_input));
+			}
+			// we want to mostly leave the input alone in case we need to re-display it to the user
+			$this->_set_normalized_value($this->_normalization_strategy->normalize($this->raw_value()));
+			return false;
+		} catch (EE_Validation_Error $e) {
+			$this->add_validation_error($e);
+			return true;
+		}
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_name()
+	{
+		$this->_set_default_html_name_if_empty();
+		return $this->_html_name ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 * @throws EE_Error
+	 */
+	public function html_label_id()
+	{
+		return ! empty($this->_html_label_id)
+			? $this->_html_label_id
+			: $this->html_id() . '-lbl';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_class()
+	{
+		return $this->_html_label_class ?? '';
+	}
+
+
+	/**
+	 * @param string $html_class
+	 */
+	public function add_html_label_class(string $html_class)
+	{
+		$this->_html_label_class .= ' ' . trim($html_class);
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_style()
+	{
+		return $this->_html_label_style ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_label_text()
+	{
+		return $this->_html_label_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_text()
+	{
+		return $this->_html_help_text ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_class()
+	{
+		return $this->_html_help_class ?? '';
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function html_help_style()
+	{
+		return $this->_html_style ?? '';
+	}
+
+
+	/**
+	 * returns the raw, UNSAFE, input, almost exactly as the user submitted it.
+	 * Please note that almost all client code should instead use the normalized_value;
+	 * or possibly raw_value_in_form (which prepares the string for displaying in an HTML attribute on a tag,
+	 * mostly by escaping quotes)
+	 * Note, we do not store the exact original value sent in the user's request because
+	 * it may have malicious content, and we MIGHT want to store the form input in a transient or something...
+	 * in which case, we would have stored the malicious content to our database.
+	 *
+	 * @return mixed
+	 */
+	public function raw_value()
+	{
+		return $this->_raw_value;
+	}
+
+
+	/**
+	 * Returns a string safe to usage in form inputs when displaying, because
+	 * it escapes all html entities
+	 *
+	 * @return string
+	 */
+	public function raw_value_in_form(): string
+	{
+		return htmlentities((string) $this->raw_value(), ENT_QUOTES, 'UTF-8');
+	}
+
+
+	/**
+	 * returns the value after it's been sanitized, and then converted into it's proper type
+	 * in PHP. Eg, a string, an int, an array,
+	 *
+	 * @return mixed
+	 */
+	public function normalized_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * Returns the normalized value is a presentable way. By default this is just
+	 * the normalized value by itself, but it can be overridden for when that's not
+	 * the best thing to display
+	 *
+	 * @return mixed
+	 */
+	public function pretty_value()
+	{
+		return $this->_normalized_value;
+	}
+
+
+	/**
+	 * When generating the JS for the jquery validation rules like<br>
+	 * <code>$( "#myform" ).validate({
+	 * rules: {
+	 * password: "required",
+	 * password_again: {
+	 * equalTo: "#password"
+	 * }
+	 * }
+	 * });</code>
+	 * if this field had the name 'password_again', it should return
+	 * <br><code>password_again: {
+	 * equalTo: "#password"
+	 * }</code>
+	 *
+	 * @return array
+	 */
+	public function get_jquery_validation_rules(): array
+	{
+		$jquery_validation_js    = [];
+		$jquery_validation_rules = [];
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$jquery_validation_rules = array_replace_recursive(
+				$jquery_validation_rules,
+				$validation_strategy->get_jquery_validation_rule_array()
+			);
+		}
+		if (! empty($jquery_validation_rules)) {
+			foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
+				$jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+			}
+		}
+		return $jquery_validation_js;
+	}
+
+
+	/**
+	 * Sets the input's default value for use in displaying in the form. Note: value should be
+	 * normalized (Eg, if providing a default of ra Yes_NO_Input you would provide TRUE or FALSE, not '1' or '0')
+	 *
+	 * @param mixed $value
+	 * @return void
+	 */
+	public function set_default($value)
+	{
+		$this->_default = $value;
+		$this->_set_normalized_value($value);
+		$this->_set_raw_value($value);
+	}
+
+
+	/**
+	 * Sets the normalized value on this input
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_normalized_value($value)
+	{
+		$this->_normalized_value = $value;
+	}
+
+
+	/**
+	 * Sets the raw value on this input (ie, exactly as the user submitted it)
+	 *
+	 * @param mixed $value
+	 */
+	protected function _set_raw_value($value)
+	{
+		$this->_raw_value = $this->_normalization_strategy->unnormalize($value);
+	}
+
+
+	/**
+	 * Sets the HTML label text after it has already been defined
+	 *
+	 * @param string $label
+	 * @return void
+	 */
+	public function set_html_label_text($label)
+	{
+		$this->_html_label_text = $label;
+	}
+
+
+	/**
+	 * Sets whether or not this field is required, and adjusts the validation strategy.
+	 * If you want to use the EE_Conditionally_Required_Validation_Strategy,
+	 * please add it as a validation strategy using add_validation_strategy as normal
+	 *
+	 * @param boolean $required boolean
+	 * @param null    $required_text
+	 */
+	public function set_required($required = true, $required_text = null)
+	{
+		$required = filter_var($required, FILTER_VALIDATE_BOOLEAN);
+		// whether $required is a string or a boolean, we want to add a required validation strategy
+		if ($required) {
+			$this->_add_validation_strategy(new EE_Required_Validation_Strategy($required_text));
+		} else {
+			$this->remove_validation_strategy('EE_Required_Validation_Strategy');
+		}
+		$this->_required = $required;
+	}
+
+
+	/**
+	 * Returns whether or not this field is required
+	 *
+	 * @return boolean
+	 */
+	public function required()
+	{
+		return $this->_required;
+	}
+
+
+	/**
+	 * @param string $required_css_class
+	 */
+	public function set_required_css_class($required_css_class)
+	{
+		$this->_required_css_class = $required_css_class;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function required_css_class()
+	{
+		return $this->_required_css_class;
+	}
+
+
+	/**
+	 * @param bool $add_required
+	 * @return string
+	 */
+	public function html_class($add_required = false)
+	{
+		return $add_required && $this->required()
+			? $this->required_css_class() . ' ' . $this->_html_class
+			: $this->_html_class;
+	}
+
+
+	/**
+	 * Sets the help text, in case
+	 *
+	 * @param string $text
+	 */
+	public function set_html_help_text($text)
+	{
+		$this->_html_help_text = $text;
+	}
+
+
+	/**
+	 * Uses the sensitive data removal strategy to remove the sensitive data from this
+	 * input. If there is any kind of sensitive data removal on this input, we clear
+	 * out the raw value completely
+	 *
+	 * @return void
+	 */
+	public function clean_sensitive_data()
+	{
+		// if we do ANY kind of sensitive data removal on this, then just clear out the raw value
+		// if we need more logic than this we'll make a strategy for it
+		if (
+			$this->_sensitive_data_removal_strategy
+			&& ! $this->_sensitive_data_removal_strategy instanceof EE_No_Sensitive_Data_Removal
+		) {
+			$this->_set_raw_value(null);
+		}
+		// and clean the normalized value according to the appropriate strategy
+		$this->_set_normalized_value(
+			$this->get_sensitive_data_removal_strategy()->remove_sensitive_data(
+				$this->_normalized_value
+			)
+		);
+	}
+
+
+	/**
+	 * @param bool   $primary
+	 * @param string $button_size
+	 * @param string $other_attributes
+	 */
+	public function set_button_css_attributes($primary = true, $button_size = '', $other_attributes = '')
+	{
+		$button_css_attributes = 'button';
+		$button_css_attributes .= $primary === true
+			? ' button--primary'
+			: ' button--secondary';
+		switch ($button_size) {
+			case 'xs':
+			case 'extra-small':
+				$button_css_attributes .= ' button-xs';
+				break;
+			case 'sm':
+			case 'small':
+				$button_css_attributes .= ' button-sm';
+				break;
+			case 'lg':
+			case 'large':
+				$button_css_attributes .= ' button-lg';
+				break;
+			case 'block':
+				$button_css_attributes .= ' button-block';
+				break;
+			case 'md':
+			case 'medium':
+			default:
+				$button_css_attributes .= '';
+		}
+		$this->_button_css_attributes .= ! empty($other_attributes)
+			? $button_css_attributes . ' ' . $other_attributes
+			: $button_css_attributes;
+	}
+
+
+	/**
+	 * @return string
+	 */
+	public function button_css_attributes()
+	{
+		if (empty($this->_button_css_attributes)) {
+			$this->set_button_css_attributes();
+		}
+		return $this->_button_css_attributes;
+	}
+
+
+	/**
+	 * find_form_data_for_this_section
+	 * using this section's name and its parents, finds the value of the form data that corresponds to it.
+	 * For example, if this form section's HTML name is my_form[subform][form_input_1],
+	 * then it's value should be in request at request['my_form']['subform']['form_input_1'].
+	 * (If that doesn't exist, we also check for this subsection's name
+	 * at the TOP LEVEL of the request data. Eg request['form_input_1'].)
+	 * This function finds its value in the form.
+	 *
+	 * @param array $req_data
+	 * @return mixed whatever the raw value of this form section is in the request data
+	 * @throws EE_Error
+	 */
+	public function find_form_data_for_this_section($req_data)
+	{
+		$name_parts = $this->getInputNameParts();
+		// now get the value for the input
+		$value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
+		// check if this thing's name is at the TOP level of the request data
+		if ($value === null && isset($req_data[ $this->name() ])) {
+			$value = $req_data[ $this->name() ];
+		}
+		return $value;
+	}
+
+
+	/**
+	 * If this input's name is something like "foo[bar][baz]"
+	 * returns an array like `array('foo','bar',baz')`
+	 *
+	 * @return array
+	 * @throws EE_Error
+	 */
+	protected function getInputNameParts()
+	{
+		// break up the html name by "[]"
+		if (strpos($this->html_name(), '[') !== false) {
+			$before_any_brackets = substr($this->html_name(), 0, strpos($this->html_name(), '['));
+		} else {
+			$before_any_brackets = $this->html_name();
+		}
+		// grab all of the segments
+		preg_match_all('~\[([^]]*)\]~', $this->html_name(), $matches);
+		if (isset($matches[1]) && is_array($matches[1])) {
+			$name_parts = $matches[1];
+			array_unshift($name_parts, $before_any_brackets);
+		} else {
+			$name_parts = [$before_any_brackets];
+		}
+		return $name_parts;
+	}
+
+
+	/**
+	 * @param array $html_name_parts
+	 * @param array $req_data
+	 * @return array | NULL
+	 */
+	public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
+	{
+		$first_part_to_consider = array_shift($html_name_parts);
+		if (isset($req_data[ $first_part_to_consider ])) {
+			if (empty($html_name_parts)) {
+				return $req_data[ $first_part_to_consider ];
+			} else {
+				return $this->findRequestForSectionUsingNameParts(
+					$html_name_parts,
+					$req_data[ $first_part_to_consider ]
+				);
+			}
+		} else {
+			return null;
+		}
+	}
+
+
+	/**
+	 * Checks if this form input's data is in the request data
+	 *
+	 * @param array $req_data
+	 * @return boolean
+	 * @throws EE_Error
+	 */
+	public function form_data_present_in($req_data = null)
+	{
+		if ($req_data === null) {
+			/** @var RequestInterface $request */
+			$request  = LoaderFactory::getLoader()->getShared(RequestInterface::class);
+			$req_data = $request->postParams();
+		}
+		$checked_value = $this->find_form_data_for_this_section($req_data);
+		if ($checked_value !== null) {
+			return true;
+		} else {
+			return false;
+		}
+	}
+
+
+	/**
+	 * Overrides parent to add js data from validation and display strategies
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data($form_other_js_data = [])
+	{
+		return $this->get_other_js_data_from_strategies($form_other_js_data);
+	}
+
+
+	/**
+	 * Gets other JS data for localization from this input's strategies, like
+	 * the validation strategies and the display strategy
+	 *
+	 * @param array $form_other_js_data
+	 * @return array
+	 */
+	public function get_other_js_data_from_strategies($form_other_js_data = [])
+	{
+		$form_other_js_data = $this->get_display_strategy()->get_other_js_data($form_other_js_data);
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$form_other_js_data = $validation_strategy->get_other_js_data($form_other_js_data);
+		}
+		return $form_other_js_data;
+	}
+
+
+	/**
+	 * Override parent because we want to give our strategies an opportunity to enqueue some js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js()
+	{
+		// ask our display strategy and validation strategies if they have js to enqueue
+		$this->enqueue_js_from_strategies();
+	}
+
+
+	/**
+	 * Tells strategies when its ok to enqueue their js and css
+	 *
+	 * @return void
+	 */
+	public function enqueue_js_from_strategies()
+	{
+		$this->get_display_strategy()->enqueue_js();
+		foreach ($this->get_validation_strategies() as $validation_strategy) {
+			$validation_strategy->enqueue_js();
+		}
+	}
+
+
+	/**
+	 * Gets the default value set on the input (not the current value, which may have been
+	 * changed because of a form submission). If no default was set, this us null.
+	 *
+	 * @return mixed
+	 */
+	public function get_default()
+	{
+		return $this->_default;
+	}
+
+
+	/**
+	 * Makes this input disabled. That means it will have the HTML attribute 'disabled="disabled"',
+	 * and server-side if any input was received it will be ignored
+	 */
+	public function disable($disable = true)
+	{
+		$disabled_attribute = ' disabled="disabled"';
+		$this->disabled     = filter_var($disable, FILTER_VALIDATE_BOOLEAN);
+		if ($this->disabled) {
+			if (strpos($this->_other_html_attributes, $disabled_attribute) === false) {
+				$this->_other_html_attributes .= $disabled_attribute;
+			}
+			$this->_set_normalized_value($this->get_default());
+		} else {
+			$this->_other_html_attributes = str_replace($disabled_attribute, '', $this->_other_html_attributes);
+		}
+	}
+
+
+	/**
+	 * Returns whether or not this input is currently disabled.
+	 *
+	 * @return bool
+	 */
+	public function isDisabled()
+	{
+		return $this->disabled;
+	}
 }

Spacing +20 added lines, -20 removed lines

@@ -201,7 +201,7 @@ 
         if (isset($input_args['validation_strategies'])) {
             foreach ((array) $input_args['validation_strategies'] as $validation_strategy) {
                 if ($validation_strategy instanceof EE_Validation_Strategy_Base && empty($input_args['ignore_input'])) {
-                    $this->_validation_strategies[ get_class($validation_strategy) ] = $validation_strategy;
+                    $this->_validation_strategies[get_class($validation_strategy)] = $validation_strategy;
                 }
             }
             unset($input_args['validation_strategies']);
@@ -212,7 +212,7 @@ 
         // loop thru incoming options
         foreach ($input_args as $key => $value) {
             // add underscore to $key to match property names
-            $_key = '_' . $key;
+            $_key = '_'.$key;
             if (property_exists($this, $_key)) {
                 $this->{$_key} = $value;
             }
@@ -230,7 +230,7 @@ 
         if (isset($input_args['ignore_input'])) {
             $this->_normalization_strategy = new EE_Null_Normalization();
         }
-        if (! $this->_normalization_strategy) {
+        if ( ! $this->_normalization_strategy) {
             $this->_normalization_strategy = new EE_Text_Normalization();
         }
         $this->_normalization_strategy->_construct_finalize($this);
@@ -239,7 +239,7 @@ 
             $this->set_default($input_args['default']);
             unset($input_args['default']);
         }
-        if (! $this->_sensitive_data_removal_strategy) {
+        if ( ! $this->_sensitive_data_removal_strategy) {
             $this->_sensitive_data_removal_strategy = new EE_No_Sensitive_Data_Removal();
         }
         $this->_sensitive_data_removal_strategy->_construct_finalize($this);
@@ -255,10 +255,10 @@ 
      */
     protected function _set_default_html_name_if_empty()
     {
-        if (! $this->_html_name) {
+        if ( ! $this->_html_name) {
             $this->_html_name = $this->name();
             if ($this->_parent_section && $this->_parent_section instanceof EE_Form_Section_Proper) {
-                $this->_html_name = $this->_parent_section->html_name_prefix() . "[{$this->name()}]";
+                $this->_html_name = $this->_parent_section->html_name_prefix()."[{$this->name()}]";
             }
         }
     }
@@ -288,7 +288,7 @@ 
     protected function _get_display_strategy()
     {
         $this->ensure_construct_finalized_called();
-        if (! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
+        if ( ! $this->_display_strategy || ! $this->_display_strategy instanceof EE_Display_Strategy_Base) {
             throw new EE_Error(
                 sprintf(
                     esc_html__(
@@ -444,7 +444,7 @@ 
                 $validation_strategy instanceof $validation_strategy_classname
                 || is_subclass_of($validation_strategy, $validation_strategy_classname)
             ) {
-                unset($this->_validation_strategies[ $key ]);
+                unset($this->_validation_strategies[$key]);
             }
         }
     }
@@ -646,7 +646,7 @@ 
             if (is_array($raw_input)) {
                 $raw_value = [];
                 foreach ($raw_input as $key => $value) {
-                    $raw_value[ $key ] = $this->_sanitize($value);
+                    $raw_value[$key] = $this->_sanitize($value);
                 }
                 $this->_set_raw_value($raw_value);
             } else {
@@ -681,7 +681,7 @@ 
     {
         return ! empty($this->_html_label_id)
             ? $this->_html_label_id
-            : $this->html_id() . '-lbl';
+            : $this->html_id().'-lbl';
     }
 
 
@@ -699,7 +699,7 @@ 
      */
     public function add_html_label_class(string $html_class)
     {
-        $this->_html_label_class .= ' ' . trim($html_class);
+        $this->_html_label_class .= ' '.trim($html_class);
     }
 
 
@@ -829,9 +829,9 @@ 
                 $validation_strategy->get_jquery_validation_rule_array()
             );
         }
-        if (! empty($jquery_validation_rules)) {
+        if ( ! empty($jquery_validation_rules)) {
             foreach ($this->get_display_strategy()->get_html_input_ids(true) as $html_id_with_pound_sign) {
-                $jquery_validation_js[ $html_id_with_pound_sign ] = $jquery_validation_rules;
+                $jquery_validation_js[$html_id_with_pound_sign] = $jquery_validation_rules;
             }
         }
         return $jquery_validation_js;
@@ -944,7 +944,7 @@ 
     public function html_class($add_required = false)
     {
         return $add_required && $this->required()
-            ? $this->required_css_class() . ' ' . $this->_html_class
+            ? $this->required_css_class().' '.$this->_html_class
             : $this->_html_class;
     }
 
@@ -1019,7 +1019,7 @@ 
                 $button_css_attributes .= '';
         }
         $this->_button_css_attributes .= ! empty($other_attributes)
-            ? $button_css_attributes . ' ' . $other_attributes
+            ? $button_css_attributes.' '.$other_attributes
             : $button_css_attributes;
     }
 
@@ -1055,8 +1055,8 @@ 
         // now get the value for the input
         $value = $this->findRequestForSectionUsingNameParts($name_parts, $req_data);
         // check if this thing's name is at the TOP level of the request data
-        if ($value === null && isset($req_data[ $this->name() ])) {
-            $value = $req_data[ $this->name() ];
+        if ($value === null && isset($req_data[$this->name()])) {
+            $value = $req_data[$this->name()];
         }
         return $value;
     }
@@ -1097,13 +1097,13 @@ 
     public function findRequestForSectionUsingNameParts($html_name_parts, $req_data)
     {
         $first_part_to_consider = array_shift($html_name_parts);
-        if (isset($req_data[ $first_part_to_consider ])) {
+        if (isset($req_data[$first_part_to_consider])) {
             if (empty($html_name_parts)) {
-                return $req_data[ $first_part_to_consider ];
+                return $req_data[$first_part_to_consider];
             } else {
                 return $this->findRequestForSectionUsingNameParts(
                     $html_name_parts,
-                    $req_data[ $first_part_to_consider ]
+                    $req_data[$first_part_to_consider]
                 );
             }
         } else {