eventespresso / event-espresso-core

core/db_models/EEM_Form_Element.model.php

Indentation +224 added lines, -224 removed lines

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

core/db_models/fields/EE_Foreign_Key_Int_Field.php

Indentation +29 added lines, -29 removed lines

@@ -4,36 +4,36 @@
 
 class EE_Foreign_Key_Int_Field extends EE_Foreign_Key_Field_Base
 {
-    /**
-     * @param string  $table_column  name fo column for field
-     * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
-     * @param boolean $nullable
-     * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
-     *                               dbe a string
-     * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
-     *                               "EEM_"
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
-        $this->setSchemaType(SchemaType::INTEGER);
-    }
+	/**
+	 * @param string  $table_column  name fo column for field
+	 * @param string  $nicename      should eb internationalized with esc_html__('blah','event_espresso')
+	 * @param boolean $nullable
+	 * @param mixed   $default_value if this is a integer field, it shoudl be an int. if it's a string field, it shoul
+	 *                               dbe a string
+	 * @param string|string[]  $model_name    eg 'Event','Answer','Term', etc. Basically its the model class's name without the
+	 *                               "EEM_"
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, $model_name)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $model_name);
+		$this->setSchemaType(SchemaType::INTEGER);
+	}
 
 
-    /**
-     * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
-     * @return int
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
-            $value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
-        }
-        return absint($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * @param int|EE_Base_Class $value_inputted_for_field_on_model_object
+	 * @return int
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if ($this->is_model_obj_of_type_pointed_to($value_inputted_for_field_on_model_object)) {
+			$value_inputted_for_field_on_model_object = $value_inputted_for_field_on_model_object->ID();
+		}
+		return absint($value_inputted_for_field_on_model_object);
+	}
 
-    public function prepare_for_set_from_db($value_found_in_db_for_model_object)
-    {
-        return intval($value_found_in_db_for_model_object);
-    }
+	public function prepare_for_set_from_db($value_found_in_db_for_model_object)
+	{
+		return intval($value_found_in_db_for_model_object);
+	}
 }

core/db_models/fields/EE_WP_Post_Status_Field.php

Indentation +102 added lines, -102 removed lines

@@ -2,120 +2,120 @@
 
 class EE_WP_Post_Status_Field extends EE_Enum_Text_Field
 {
-    protected $_wp_post_stati;
+	protected $_wp_post_stati;
 
 
-    /**
-     * constructor
-     *
-     * @param string $table_column        column on table
-     * @param string $nicename            nice name for column(field)
-     * @param bool   $nullable            is this field nullable
-     * @param string $default_value       default status
-     * @param array  $new_stati           If additional stati are to be used other than the default WP statuses then
-     *                                    they can be registered via this property.  The format of the array should be
-     *                                    as follows: array(
-     *                                    'status_reference' => array(
-     *                                    'label' => esc_html__('Status Reference Label', 'event_espresso')
-     *                                    'public' => true, //'Whether posts of this status should be shown on the
-     *                                    frontend of the site'
-     *                                    'exclude_from_search' => false, //'Whether posts of this status should be
-     *                                    excluded from wp searches'
-     *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
-     *                                    in queries for the admin "all" view in list table views.
-     *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
-     *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
-     *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
-     *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
-     *                                    on the admin screen( or you won't see your status count ).
-     *                                    )
-     *                                    )
-     * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value, array $new_stati = [])
-    {
-        $this->_register_new_stati($new_stati);
-        $this->_set_allowed_enum_values();
-        parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
-    }
+	/**
+	 * constructor
+	 *
+	 * @param string $table_column        column on table
+	 * @param string $nicename            nice name for column(field)
+	 * @param bool   $nullable            is this field nullable
+	 * @param string $default_value       default status
+	 * @param array  $new_stati           If additional stati are to be used other than the default WP statuses then
+	 *                                    they can be registered via this property.  The format of the array should be
+	 *                                    as follows: array(
+	 *                                    'status_reference' => array(
+	 *                                    'label' => esc_html__('Status Reference Label', 'event_espresso')
+	 *                                    'public' => true, //'Whether posts of this status should be shown on the
+	 *                                    frontend of the site'
+	 *                                    'exclude_from_search' => false, //'Whether posts of this status should be
+	 *                                    excluded from wp searches'
+	 *                                    'show_in_admin_all_list' => true, //whether posts of this status are included
+	 *                                    in queries for the admin "all" view in list table views.
+	 *                                    'show_in_admin_status_list' => true, //Show in the list of statuses with post
+	 *                                    counts at the top of the admin list tables (i.e. Status Reference(2) )
+	 *                                    'label_count' => _n_noop( 'Status Reference <span class="count">(%s)</span>',
+	 *                                    'Status References <span class="count">(%s)</span>' ), //the text to display
+	 *                                    on the admin screen( or you won't see your status count ).
+	 *                                    )
+	 *                                    )
+	 * @link http://codex.wordpress.org/Function_Reference/register_post_status for more info
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value, array $new_stati = [])
+	{
+		$this->_register_new_stati($new_stati);
+		$this->_set_allowed_enum_values();
+		parent::__construct($table_column, $nicename, $nullable, $default_value, $this->_allowed_enum_values);
+	}
 
 
-    /**
-     * This registers any new statuses sent via the $new_stati array on construct
-     *
-     * @access protected
-     * @param array $new_stati statuses
-     * @return void
-     */
-    protected function _register_new_stati($new_stati)
-    {
-        foreach ((array) $new_stati as $status_key => $status_args) {
-            $args = [
-                'label'                     => $status_args['label'] ?? $status_key,
-                'public'                    => ! (isset($status_args['public']) && is_bool($status_args['public']))
-                                               || $status_args['public'],
-                'exclude_from_search'       => isset($status_args['exclude_from_search'])
-                                               && is_bool($status_args['exclude_from_search'])
-                                               && $status_args['exclude_from_search'],
-                'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list'])
-                                               && is_bool($status_args['show_in_admin_all_list'])
-                                               && $status_args['show_in_admin_all_list'],
-                'show_in_admin_status_list' => ! (
-                        isset($status_args['show_in_admin_status_list'])
-                        && is_bool($status_args['show_in_admin_status_list'])
-                    ) || $status_args['show_in_admin_status_list'],
-                'label_count'               => $status_args['label_count'] ?? '',
-            ];
-            register_post_status($status_key, $args);
-        }
-    }
+	/**
+	 * This registers any new statuses sent via the $new_stati array on construct
+	 *
+	 * @access protected
+	 * @param array $new_stati statuses
+	 * @return void
+	 */
+	protected function _register_new_stati($new_stati)
+	{
+		foreach ((array) $new_stati as $status_key => $status_args) {
+			$args = [
+				'label'                     => $status_args['label'] ?? $status_key,
+				'public'                    => ! (isset($status_args['public']) && is_bool($status_args['public']))
+											   || $status_args['public'],
+				'exclude_from_search'       => isset($status_args['exclude_from_search'])
+											   && is_bool($status_args['exclude_from_search'])
+											   && $status_args['exclude_from_search'],
+				'show_in_admin_all_list'    => isset($status_args['show_in_admin_all_list'])
+											   && is_bool($status_args['show_in_admin_all_list'])
+											   && $status_args['show_in_admin_all_list'],
+				'show_in_admin_status_list' => ! (
+						isset($status_args['show_in_admin_status_list'])
+						&& is_bool($status_args['show_in_admin_status_list'])
+					) || $status_args['show_in_admin_status_list'],
+				'label_count'               => $status_args['label_count'] ?? '',
+			];
+			register_post_status($status_key, $args);
+		}
+	}
 
 
-    /**
-     * This sets the _allowed_enum_values property using the $wp_post_stati array
-     *
-     * @access protected
-     * @regurn void
-     */
-    protected function _set_allowed_enum_values()
-    {
-        // first let's get the post_statuses
-        global $wp_post_statuses;
-        $this->_wp_post_stati = $wp_post_statuses;
+	/**
+	 * This sets the _allowed_enum_values property using the $wp_post_stati array
+	 *
+	 * @access protected
+	 * @regurn void
+	 */
+	protected function _set_allowed_enum_values()
+	{
+		// first let's get the post_statuses
+		global $wp_post_statuses;
+		$this->_wp_post_stati = $wp_post_statuses;
 
-        foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
-        }
-    }
+		foreach ($this->_wp_post_stati as $post_status => $args_object) {
+			$this->_allowed_enum_values[ $post_status ] = $args_object->label;
+		}
+	}
 
 
-    /**
-     * Before calling parent, first double-checks our list of acceptable post
-     * types is up-to-date
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        $this->_set_allowed_enum_values();
-        return parent::prepare_for_set($value_inputted_for_field_on_model_object);
-    }
+	/**
+	 * Before calling parent, first double-checks our list of acceptable post
+	 * types is up-to-date
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		$this->_set_allowed_enum_values();
+		return parent::prepare_for_set($value_inputted_for_field_on_model_object);
+	}
 
 
 
-    // helper methods for getting various $wp_post_statuses stuff.
+	// helper methods for getting various $wp_post_statuses stuff.
 
 
-    /**
-     * This just returns the status object for the given status
-     *
-     * @param string $status What status object you want
-     * @return object|null         the status object or FALSE if it doesn't exist.
-     * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
-     */
-    public function get_status_object($status)
-    {
-        return $this->_wp_post_stati[ $status ] ?? null;
-    }
+	/**
+	 * This just returns the status object for the given status
+	 *
+	 * @param string $status What status object you want
+	 * @return object|null         the status object or FALSE if it doesn't exist.
+	 * @see    wp_register_post_status in wp-includes/post.php for a list of properties of the status object
+	 */
+	public function get_status_object($status)
+	{
+		return $this->_wp_post_stati[ $status ] ?? null;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -84,7 +84,7 @@ 
         $this->_wp_post_stati = $wp_post_statuses;
 
         foreach ($this->_wp_post_stati as $post_status => $args_object) {
-            $this->_allowed_enum_values[ $post_status ] = $args_object->label;
+            $this->_allowed_enum_values[$post_status] = $args_object->label;
         }
     }
 
@@ -116,6 +116,6 @@ 
      */
     public function get_status_object($status)
     {
-        return $this->_wp_post_stati[ $status ] ?? null;
+        return $this->_wp_post_stati[$status] ?? null;
     }
 }

core/db_models/fields/EE_Enum_Text_Field.php

Indentation +105 added lines, -105 removed lines

@@ -12,121 +12,121 @@
  */
 class EE_Enum_Text_Field extends EE_Text_Field_Base
 {
-    public array $_allowed_enum_values;
+	public array $_allowed_enum_values;
 
 
-    /**
-     * @param string  $table_column
-     * @param string  $nice_name
-     * @param boolean $nullable
-     * @param mixed   $default_value
-     * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
-     */
-    public function __construct($table_column, $nice_name, $nullable, $default_value, array $allowed_enum_values)
-    {
-        $this->_allowed_enum_values = (array) $allowed_enum_values;
-        parent::__construct($table_column, $nice_name, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::OBJECT);
-    }
+	/**
+	 * @param string  $table_column
+	 * @param string  $nice_name
+	 * @param boolean $nullable
+	 * @param mixed   $default_value
+	 * @param array   $allowed_enum_values keys are values to be used in the DB, values are how they should be displayed
+	 */
+	public function __construct($table_column, $nice_name, $nullable, $default_value, array $allowed_enum_values)
+	{
+		$this->_allowed_enum_values = (array) $allowed_enum_values;
+		parent::__construct($table_column, $nice_name, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::OBJECT);
+	}
 
 
-    /**
-     * Returns the list of allowed enum options, but filterable.
-     * This is used internally
-     *
-     * @return array
-     */
-    protected function _allowed_enum_values(): array
-    {
-        return (array) apply_filters(
-            'FHEE__EE_Enum_Text_Field___allowed_enum_options',
-            $this->_allowed_enum_values,
-            $this
-        );
-    }
+	/**
+	 * Returns the list of allowed enum options, but filterable.
+	 * This is used internally
+	 *
+	 * @return array
+	 */
+	protected function _allowed_enum_values(): array
+	{
+		return (array) apply_filters(
+			'FHEE__EE_Enum_Text_Field___allowed_enum_options',
+			$this->_allowed_enum_values,
+			$this
+		);
+	}
 
 
-    /**
-     * When setting, just verify that the value being used matches what we've defined as allowable enum values.
-     * If not, throw an error (but if WP_DEBUG is false, just set the value to default).
-     *
-     * @param string $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if (
-            $value_inputted_for_field_on_model_object !== null
-            && ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values())
-        ) {
-            if (defined('WP_DEBUG') && WP_DEBUG) {
-                $msg  = sprintf(
-                    esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
-                    $value_inputted_for_field_on_model_object,
-                    $this->_name
-                );
-                $msg2 = sprintf(
-                    esc_html__('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'),
-                    $this->_name,
-                    implode(', ', array_keys($this->_allowed_enum_values())),
-                    $value_inputted_for_field_on_model_object
-                );
-                EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
-            }
-            return $this->get_default_value();
-        }
-        return $value_inputted_for_field_on_model_object;
-    }
+	/**
+	 * When setting, just verify that the value being used matches what we've defined as allowable enum values.
+	 * If not, throw an error (but if WP_DEBUG is false, just set the value to default).
+	 *
+	 * @param string $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if (
+			$value_inputted_for_field_on_model_object !== null
+			&& ! array_key_exists($value_inputted_for_field_on_model_object, $this->_allowed_enum_values())
+		) {
+			if (defined('WP_DEBUG') && WP_DEBUG) {
+				$msg  = sprintf(
+					esc_html__('System is assigning incompatible value "%1$s" to field "%2$s"', 'event_espresso'),
+					$value_inputted_for_field_on_model_object,
+					$this->_name
+				);
+				$msg2 = sprintf(
+					esc_html__('Allowed values for "%1$s" are "%2$s". You provided: "%3$s"', 'event_espresso'),
+					$this->_name,
+					implode(', ', array_keys($this->_allowed_enum_values())),
+					$value_inputted_for_field_on_model_object
+				);
+				EE_Error::add_error("$msg||$msg2", __FILE__, __FUNCTION__, __LINE__);
+			}
+			return $this->get_default_value();
+		}
+		return $value_inputted_for_field_on_model_object;
+	}
 
 
-    /**
-     * Gets the pretty version of the enum's value.
-     *
-     * @param int|string  $value_on_field_to_be_outputted
-     * @param string|null $schema
-     * @return    string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        $options = $this->_allowed_enum_values();
-        return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
-    }
+	/**
+	 * Gets the pretty version of the enum's value.
+	 *
+	 * @param int|string  $value_on_field_to_be_outputted
+	 * @param string|null $schema
+	 * @return    string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		$options = $this->_allowed_enum_values();
+		return $options[ $value_on_field_to_be_outputted ] ?? $value_on_field_to_be_outputted;
+	}
 
 
-    /**
-     * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live
-     * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY
-     * when we're receiving USER input from prepare_for_set() that we enforce the enum options.
-     *
-     * @param mixed $value_in_db
-     * @return mixed
-     */
-    public function prepare_for_set_from_db($value_in_db)
-    {
-        return $value_in_db;
-    }
+	/**
+	 * When retrieving something from the DB, don't enforce the enum's options. If it's in the DB, we just have to live
+	 * with that. Note also: when we're saving to the DB again, we also don't enforce the enum options. It's ONLY
+	 * when we're receiving USER input from prepare_for_set() that we enforce the enum options.
+	 *
+	 * @param mixed $value_in_db
+	 * @return mixed
+	 */
+	public function prepare_for_set_from_db($value_in_db)
+	{
+		return $value_in_db;
+	}
 
 
-    public function getSchemaProperties(): array
-    {
-        return [
-            'raw'    => [
-                'description' => sprintf(
-                    esc_html__('%s - the value in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-                'enum'        => array_keys($this->_allowed_enum_values),
-            ],
-            'pretty' => [
-                'description' => sprintf(
-                    esc_html__('%s - the value for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-                'enum'        => array_values($this->_allowed_enum_values),
-                'read_only'   => true,
-            ],
-        ];
-    }
+	public function getSchemaProperties(): array
+	{
+		return [
+			'raw'    => [
+				'description' => sprintf(
+					esc_html__('%s - the value in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+				'enum'        => array_keys($this->_allowed_enum_values),
+			],
+			'pretty' => [
+				'description' => sprintf(
+					esc_html__('%s - the value for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+				'enum'        => array_values($this->_allowed_enum_values),
+				'read_only'   => true,
+			],
+		];
+	}
 }

core/db_models/fields/EE_Post_Content_Field.php

Indentation +121 added lines, -121 removed lines

@@ -8,133 +8,133 @@
  */
 class EE_Post_Content_Field extends EE_Text_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::STRING);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::STRING);
+	}
 
 
-    /**
-     * removes all tags which a WP Post wouldn't allow in its content normally
-     *
-     * @param string $value
-     * @return string
-     */
-    public function prepare_for_set($value)
-    {
-        if (! current_user_can('unfiltered_html')) {
-            $value = wp_kses("$value", wp_kses_allowed_html('post'));
-        }
-        return parent::prepare_for_set($value);
-    }
+	/**
+	 * removes all tags which a WP Post wouldn't allow in its content normally
+	 *
+	 * @param string $value
+	 * @return string
+	 */
+	public function prepare_for_set($value)
+	{
+		if (! current_user_can('unfiltered_html')) {
+			$value = wp_kses("$value", wp_kses_allowed_html('post'));
+		}
+		return parent::prepare_for_set($value);
+	}
 
 
-    /**
-     * Runs the content through `the_content`, or if prepares the content for placing in a form input
-     *
-     * @param string      $value_on_field_to_be_outputted
-     * @param string|null $schema possible values: 'form_input' or null (if null, will run through 'the_content')
-     * @return string
-     * @throws EE_Error when WP_DEBUG is on and recursive calling is detected
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        switch ($schema) {
-            case 'form_input':
-                return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
-            case 'the_content':
-                if (doing_filter('the_content')) {
-                    if (defined('WP_DEBUG') && WP_DEBUG) {
-                        throw new EE_Error(
-                            sprintf(
-                                esc_html__(
-                                    'You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.',
-                                    'event_espresso'
-                                ),
-                                'EE_Post_Content_Field::prepare_for_pretty_echoing',
-                                '$schema',
-                                'the_content',
-                                'the_content_wp_core_only'
-                            )
-                        );
-                    } else {
-                        return $this->prepare_for_pretty_echoing(
-                            $value_on_field_to_be_outputted,
-                            'the_content_wp_core_only'
-                        );
-                    }
-                }
-                return apply_filters(
-                    'the_content',
-                    parent::prepare_for_pretty_echoing(
-                        $value_on_field_to_be_outputted,
-                        $schema
-                    )
-                );
-            case 'the_content_wp_core_only':
-            default:
-                self::_setup_the_content_wp_core_only_filters();
-                $return_value = apply_filters(
-                    'the_content_wp_core_only',
-                    parent::prepare_for_pretty_echoing(
-                        $value_on_field_to_be_outputted,
-                        $schema
-                    )
-                );
-                // ya know what? adding these filters is super fast. Let's just
-                // avoid needing to maintain global state and set this up as-needed
-                remove_all_filters('the_content_wp_core_only');
-                do_action('AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
-                return $return_value;
-        }
-    }
+	/**
+	 * Runs the content through `the_content`, or if prepares the content for placing in a form input
+	 *
+	 * @param string      $value_on_field_to_be_outputted
+	 * @param string|null $schema possible values: 'form_input' or null (if null, will run through 'the_content')
+	 * @return string
+	 * @throws EE_Error when WP_DEBUG is on and recursive calling is detected
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		switch ($schema) {
+			case 'form_input':
+				return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted, $schema);
+			case 'the_content':
+				if (doing_filter('the_content')) {
+					if (defined('WP_DEBUG') && WP_DEBUG) {
+						throw new EE_Error(
+							sprintf(
+								esc_html__(
+									'You have recursively called "%1$s" with %2$s set to %3$s which uses "%2$s" filter. You should use it with %2$s "%3$s" instead here.',
+									'event_espresso'
+								),
+								'EE_Post_Content_Field::prepare_for_pretty_echoing',
+								'$schema',
+								'the_content',
+								'the_content_wp_core_only'
+							)
+						);
+					} else {
+						return $this->prepare_for_pretty_echoing(
+							$value_on_field_to_be_outputted,
+							'the_content_wp_core_only'
+						);
+					}
+				}
+				return apply_filters(
+					'the_content',
+					parent::prepare_for_pretty_echoing(
+						$value_on_field_to_be_outputted,
+						$schema
+					)
+				);
+			case 'the_content_wp_core_only':
+			default:
+				self::_setup_the_content_wp_core_only_filters();
+				$return_value = apply_filters(
+					'the_content_wp_core_only',
+					parent::prepare_for_pretty_echoing(
+						$value_on_field_to_be_outputted,
+						$schema
+					)
+				);
+				// ya know what? adding these filters is super fast. Let's just
+				// avoid needing to maintain global state and set this up as-needed
+				remove_all_filters('the_content_wp_core_only');
+				do_action('AHEE__EE_Post_Content_Field__prepare_for_pretty_echoing__the_content_wp_core_only__done');
+				return $return_value;
+		}
+	}
 
 
-    /**
-     * Verifies we've setup the standard WP core filters on  'the_content_wp_core_only' filter
-     */
-    protected static function _setup_the_content_wp_core_only_filters()
-    {
-        add_filter('the_content_wp_core_only', [$GLOBALS['wp_embed'], 'run_shortcode'], 8);
-        add_filter('the_content_wp_core_only', [$GLOBALS['wp_embed'], 'autoembed'], 8);
-        add_filter('the_content_wp_core_only', 'wptexturize', 10);
-        add_filter('the_content_wp_core_only', 'wpautop', 10);
-        add_filter('the_content_wp_core_only', 'shortcode_unautop', 10);
-        add_filter('the_content_wp_core_only', 'prepend_attachment', 10);
-        if (function_exists('wp_filter_content_tags')) {
-            add_filter('the_content_wp_core_only', 'wp_filter_content_tags', 10);
-        } elseif (function_exists('wp_make_content_images_responsive')) {
-            add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10);
-        }
-        add_filter('the_content_wp_core_only', 'do_shortcode', 11);
-        add_filter('the_content_wp_core_only', 'convert_smilies', 20);
-    }
+	/**
+	 * Verifies we've setup the standard WP core filters on  'the_content_wp_core_only' filter
+	 */
+	protected static function _setup_the_content_wp_core_only_filters()
+	{
+		add_filter('the_content_wp_core_only', [$GLOBALS['wp_embed'], 'run_shortcode'], 8);
+		add_filter('the_content_wp_core_only', [$GLOBALS['wp_embed'], 'autoembed'], 8);
+		add_filter('the_content_wp_core_only', 'wptexturize', 10);
+		add_filter('the_content_wp_core_only', 'wpautop', 10);
+		add_filter('the_content_wp_core_only', 'shortcode_unautop', 10);
+		add_filter('the_content_wp_core_only', 'prepend_attachment', 10);
+		if (function_exists('wp_filter_content_tags')) {
+			add_filter('the_content_wp_core_only', 'wp_filter_content_tags', 10);
+		} elseif (function_exists('wp_make_content_images_responsive')) {
+			add_filter('the_content_wp_core_only', 'wp_make_content_images_responsive', 10);
+		}
+		add_filter('the_content_wp_core_only', 'do_shortcode', 11);
+		add_filter('the_content_wp_core_only', 'convert_smilies', 20);
+	}
 
 
-    public function getSchemaProperties(): array
-    {
-        return [
-            'raw'      => [
-                'description' => sprintf(
-                    esc_html__('%s - the content as it exists in the database.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-            ],
-            'rendered' => [
-                'description' => sprintf(
-                    esc_html__('%s - the content rendered for display.', 'event_espresso'),
-                    $this->get_nicename()
-                ),
-                'type'        => SchemaType::STRING,
-            ],
-        ];
-    }
+	public function getSchemaProperties(): array
+	{
+		return [
+			'raw'      => [
+				'description' => sprintf(
+					esc_html__('%s - the content as it exists in the database.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+			],
+			'rendered' => [
+				'description' => sprintf(
+					esc_html__('%s - the content rendered for display.', 'event_espresso'),
+					$this->get_nicename()
+				),
+				'type'        => SchemaType::STRING,
+			],
+		];
+	}
 }

core/db_models/fields/EE_Password_Field.php

Indentation +42 added lines, -42 removed lines

@@ -10,53 +10,53 @@
  */
 class EE_Password_Field extends EE_Text_Field_Base
 {
-    protected array $protected_fields;
+	protected array $protected_fields;
 
 
-    /**
-     * EE_Password_Field constructor.
-     *
-     * @param       $table_column
-     * @param       $nicename
-     * @param       $nullable
-     * @param null  $default_value
-     * @param array $protected_fields
-     */
-    public function __construct(
-        $table_column,
-        $nicename,
-        $nullable,
-        $default_value = null,
-        array $protected_fields =
-        []
-    ) {
-        $this->protected_fields = $protected_fields;
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-    }
+	/**
+	 * EE_Password_Field constructor.
+	 *
+	 * @param       $table_column
+	 * @param       $nicename
+	 * @param       $nullable
+	 * @param null  $default_value
+	 * @param array $protected_fields
+	 */
+	public function __construct(
+		$table_column,
+		$nicename,
+		$nullable,
+		$default_value = null,
+		array $protected_fields =
+		[]
+	) {
+		$this->protected_fields = $protected_fields;
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+	}
 
 
-    /**
-     * Returns the names of the fields on this model that this password field should protect
-     *
-     * @return array
-     * @since 4.9.74.p
-     */
-    public function protectedFields(): array
-    {
-        return $this->protected_fields;
-    }
+	/**
+	 * Returns the names of the fields on this model that this password field should protect
+	 *
+	 * @return array
+	 * @since 4.9.74.p
+	 */
+	public function protectedFields(): array
+	{
+		return $this->protected_fields;
+	}
 
 
-    /**
-     * Returns whether or not the specified field is protected by this model
-     *
-     * @param $field_name
-     * @return bool
-     * @since 4.9.74.p
-     */
-    public function fieldIsProtected($field_name): bool
-    {
-        return in_array($field_name, $this->protectedFields(), true);
-    }
+	/**
+	 * Returns whether or not the specified field is protected by this model
+	 *
+	 * @param $field_name
+	 * @return bool
+	 * @since 4.9.74.p
+	 */
+	public function fieldIsProtected($field_name): bool
+	{
+		return in_array($field_name, $this->protectedFields(), true);
+	}
 }
 // Location: ${NAMESPACE}/EE_Password_Field.php

core/db_models/fields/EE_Float_Field.php

Indentation +74 added lines, -74 removed lines

@@ -8,84 +8,84 @@
  */
 class EE_Float_Field extends EE_Model_Field_Base
 {
-    /**
-     * @var EE_Currency_Config
-     */
-    protected $currency;
+	/**
+	 * @var EE_Currency_Config
+	 */
+	protected $currency;
 
 
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        $this->currency = EE_Config::instance()->currency instanceof EE_Currency_Config
-            ? EE_Config::instance()->currency
-            : new EE_Currency_Config();
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::NUMBER);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		$this->currency = EE_Config::instance()->currency instanceof EE_Currency_Config
+			? EE_Config::instance()->currency
+			: new EE_Currency_Config();
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::NUMBER);
+	}
 
 
-    /**
-     * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
-     * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
-     * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, typecast as float first.
-     * Returns a float
-     *
-     * @param float|string $number
-     * @return float
-     */
-    public function prepare_for_set($number)
-    {
-        // remove whitespaces and thousands separators
-        if (is_string($number)) {
-            // scientific notation can just be cast as a float
-            if (strpos($number, 'e') || strpos($number, 'E')) {
-                return (float) $number;
-            }
-            $number = str_replace(
-                array(" ", $this->currency->thsnds),
-                "",
-                $number
-            );
-            // normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
-            $number = str_replace(
-                $this->currency->dec_mrk,
-                ".",
-                $number
-            );
-            // double-check there's absolutely nothing left on this string besides numbers
-            $number = preg_replace(
-                "/[^0-9,.]/",
-                "",
-                $number
-            );
-        }
-        return (float) $number;
-    }
+	/**
+	 * If provided a string, strips out number-related formatting, like commas, periods, spaces, other junk, etc.
+	 * However, treats commas and periods as thousand-separators ro decimal marks, as indicate by the config's currency.
+	 * So if you want to pass in a string that NEEDS to interpret periods as decimal marks, typecast as float first.
+	 * Returns a float
+	 *
+	 * @param float|string $number
+	 * @return float
+	 */
+	public function prepare_for_set($number)
+	{
+		// remove whitespaces and thousands separators
+		if (is_string($number)) {
+			// scientific notation can just be cast as a float
+			if (strpos($number, 'e') || strpos($number, 'E')) {
+				return (float) $number;
+			}
+			$number = str_replace(
+				array(" ", $this->currency->thsnds),
+				"",
+				$number
+			);
+			// normalize it so periods are decimal marks (we don't care where you're from: we're talking PHP now)
+			$number = str_replace(
+				$this->currency->dec_mrk,
+				".",
+				$number
+			);
+			// double-check there's absolutely nothing left on this string besides numbers
+			$number = preg_replace(
+				"/[^0-9,.]/",
+				"",
+				$number
+			);
+		}
+		return (float) $number;
+	}
 
-    /**
-     * Returns the number formatted according to local custom (set by the country of the blog).
-     *
-     * @param float $number
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($number, ?string $schema = null)
-    {
-        return number_format(
-            $number,
-            $this->currency->dec_plc,
-            $this->currency->dec_mrk,
-            $this->currency->thsnds
-        );
-    }
+	/**
+	 * Returns the number formatted according to local custom (set by the country of the blog).
+	 *
+	 * @param float $number
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($number, ?string $schema = null)
+	{
+		return number_format(
+			$number,
+			$this->currency->dec_plc,
+			$this->currency->dec_mrk,
+			$this->currency->thsnds
+		);
+	}
 
-    public function prepare_for_set_from_db($number)
-    {
-        return (float) $number;
-    }
+	public function prepare_for_set_from_db($number)
+	{
+		return (float) $number;
+	}
 }

core/db_models/fields/EE_Text_Field_Base.php

Indentation +58 added lines, -58 removed lines

@@ -8,68 +8,68 @@
  */
 abstract class EE_Text_Field_Base extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType(SchemaType::STRING);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType(SchemaType::STRING);
+	}
 
 
-    /**
-     * Gets the value in the format expected when being set.
-     * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
-     *
-     * @param mixed $value_of_field_on_model_object
-     * @return mixed|string
-     */
-    public function prepare_for_get($value_of_field_on_model_object)
-    {
-        if ($value_of_field_on_model_object === null) {
-            return $this->is_nullable() ? null : '';
-        }
-        return $value_of_field_on_model_object;
-    }
+	/**
+	 * Gets the value in the format expected when being set.
+	 * For display on the front-end, usually you would use prepare_for_pretty_echoing() instead.
+	 *
+	 * @param mixed $value_of_field_on_model_object
+	 * @return mixed|string
+	 */
+	public function prepare_for_get($value_of_field_on_model_object)
+	{
+		if ($value_of_field_on_model_object === null) {
+			return $this->is_nullable() ? null : '';
+		}
+		return $value_of_field_on_model_object;
+	}
 
 
-    /**
-     * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
-     *
-     * @param mixed       $value_on_field_to_be_outputted
-     * @param string|null $schema
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        if ($schema === 'form_input') {
-            $value_on_field_to_be_outputted = htmlentities(
-                (string) $value_on_field_to_be_outputted,
-                ENT_QUOTES,
-                'UTF-8'
-            );
-        }
-        return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
-    }
+	/**
+	 * Accepts schema of 'form_input' which formats the string for echoing in form input's value.
+	 *
+	 * @param mixed       $value_on_field_to_be_outputted
+	 * @param string|null $schema
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		if ($schema === 'form_input') {
+			$value_on_field_to_be_outputted = htmlentities(
+				(string) $value_on_field_to_be_outputted,
+				ENT_QUOTES,
+				'UTF-8'
+			);
+		}
+		return parent::prepare_for_pretty_echoing($value_on_field_to_be_outputted);
+	}
 
 
-    /**
-     * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
-     * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
-     * in magic-quotes fashion. We used to call html_entity_decode on the value here,
-     * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
-     * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
-     * So if we do it again here, we'll be removing HTML entities the user intended to have.)
-     *
-     * @param string|null $value_inputted_for_field_on_model_object
-     * @return string
-     */
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        return stripslashes((string) parent::prepare_for_set($value_inputted_for_field_on_model_object));
-    }
+	/**
+	 * Data received from the user should be exactly as they hope to save it in the DB, with the exception that
+	 * quotes need to have slashes added to it. This method takes care of removing the slashes added by WP
+	 * in magic-quotes fashion. We used to call html_entity_decode on the value here,
+	 * because we called htmlentities when in EE_Text_Field_Base::prepare_for_pretty_echoing, but that's not necessary
+	 * because web browsers always decode HTML entities in element attributes, like a form element's value attribute.
+	 * So if we do it again here, we'll be removing HTML entities the user intended to have.)
+	 *
+	 * @param string|null $value_inputted_for_field_on_model_object
+	 * @return string
+	 */
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		return stripslashes((string) parent::prepare_for_set($value_inputted_for_field_on_model_object));
+	}
 }

core/db_models/fields/EE_Infinite_Integer_Field.php

Indentation +65 added lines, -65 removed lines

@@ -11,77 +11,77 @@
  */
 class EE_Infinite_Integer_Field extends EE_Model_Field_Base
 {
-    /**
-     * @param string $table_column
-     * @param string $nicename
-     * @param bool   $nullable
-     * @param null   $default_value
-     */
-    public function __construct($table_column, $nicename, $nullable, $default_value = null)
-    {
-        parent::__construct($table_column, $nicename, $nullable, $default_value);
-        $this->setSchemaType([SchemaType::INTEGER, SchemaType::NULL]);
-    }
+	/**
+	 * @param string $table_column
+	 * @param string $nicename
+	 * @param bool   $nullable
+	 * @param null   $default_value
+	 */
+	public function __construct($table_column, $nicename, $nullable, $default_value = null)
+	{
+		parent::__construct($table_column, $nicename, $nullable, $default_value);
+		$this->setSchemaType([SchemaType::INTEGER, SchemaType::NULL]);
+	}
 
 
-    public function prepare_for_use_in_db($value_of_field_on_model_object)
-    {
-        if ($value_of_field_on_model_object === EE_INF) {
-            return EE_INF_IN_DB;
-        }
-        return (int) $value_of_field_on_model_object;
-    }
+	public function prepare_for_use_in_db($value_of_field_on_model_object)
+	{
+		if ($value_of_field_on_model_object === EE_INF) {
+			return EE_INF_IN_DB;
+		}
+		return (int) $value_of_field_on_model_object;
+	}
 
 
-    public function prepare_for_set($value_inputted_for_field_on_model_object)
-    {
-        if (
-            $value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
-            $value_inputted_for_field_on_model_object === EE_INF ||
-            $value_inputted_for_field_on_model_object === "EE_INF" ||
-            $value_inputted_for_field_on_model_object === ""
-        ) {
-            return EE_INF;
-        }
-        return (int) $value_inputted_for_field_on_model_object;
-    }
+	public function prepare_for_set($value_inputted_for_field_on_model_object)
+	{
+		if (
+			$value_inputted_for_field_on_model_object === EE_INF_IN_DB ||
+			$value_inputted_for_field_on_model_object === EE_INF ||
+			$value_inputted_for_field_on_model_object === "EE_INF" ||
+			$value_inputted_for_field_on_model_object === ""
+		) {
+			return EE_INF;
+		}
+		return (int) $value_inputted_for_field_on_model_object;
+	}
 
 
-    public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
-    {
-        $intval = (int) $value_inputted_for_field_on_model_object;
-        if ($intval == EE_INF_IN_DB) {
-            return EE_INF;
-        }
-        return $intval;
-    }
+	public function prepare_for_set_from_db($value_inputted_for_field_on_model_object)
+	{
+		$intval = (int) $value_inputted_for_field_on_model_object;
+		if ($intval == EE_INF_IN_DB) {
+			return EE_INF;
+		}
+		return $intval;
+	}
 
 
-    /**
-     * For outputting this field's value. If you want to output it into an input or something,
-     * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
-     * as it will replace EE_INF with i18n Infinite
-     *
-     * @param mixed       $value_on_field_to_be_outputted
-     * @param string|null $schema input, symbol, text; or any string you want to show if the value equals EE_INF
-     * @return string
-     */
-    public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
-    {
-        if ($value_on_field_to_be_outputted === EE_INF) {
-            switch ($schema) {
-                case 'input':
-                case 'form_input':
-                    return '';
-                case 'symbol':
-                    return "∞";
-                case 'text':
-                case null:
-                    return esc_html__("Unlimited", "event_espresso");
-                default:
-                    return $schema;
-            }
-        }
-        return $value_on_field_to_be_outputted;
-    }
+	/**
+	 * For outputting this field's value. If you want to output it into an input or something,
+	 * use $schema=='input', as it will replace EE_INF with ''. If you want a readable version, use $schema=='text'
+	 * as it will replace EE_INF with i18n Infinite
+	 *
+	 * @param mixed       $value_on_field_to_be_outputted
+	 * @param string|null $schema input, symbol, text; or any string you want to show if the value equals EE_INF
+	 * @return string
+	 */
+	public function prepare_for_pretty_echoing($value_on_field_to_be_outputted, ?string $schema = null)
+	{
+		if ($value_on_field_to_be_outputted === EE_INF) {
+			switch ($schema) {
+				case 'input':
+				case 'form_input':
+					return '';
+				case 'symbol':
+					return "∞";
+				case 'text':
+				case null:
+					return esc_html__("Unlimited", "event_espresso");
+				default:
+					return $schema;
+			}
+		}
+		return $value_on_field_to_be_outputted;
+	}
 }