bookmark_borderGF_Field_Number

Introduction

The GF_Field_Number class extends the GF_Field class, also known as the Field Object. This class is responsible for determining how the Number field is rendered when the form is displayed and how its value is handled during and after form submission. If a field is a Quantity field and Number is the chosen type of quantity, then this also handles the Quantity field.

Settings and Properties

Settings control what options are available to the admin user when configuring the field in the form editor. Gravity Forms includes many built-in settings such as Field Label, Field Description, Choices, Conditional Logic, etc. In addition to built-in settings, custom settings can also be developed. For more information on how to develop custom settings and how to associate settings to a field, visit the GF_Field page.

Properties contain the values specified by the settings and generally are part of the Field Object.

The properties may be retrieved by accessing the Field Object as follows:

//get the field
$field = GFFormsModel::get_field( $form, 1 );

//get the admin label
$admin_label = $field->adminLabel;

Settings

The following settings are available for the field:

  • admin_label_setting
    Controls whether the “Admin Field Label” setting appears.

  • calculation_setting
    Determines whether the “Enable Calculation” setting displays. This allows a calculation to be used for the number.

  • conditional_logic_field_setting
    Controls whether the “Enable Conditional Logic” setting appears.

  • css_class_setting
    Controls whether the “Custom CSS Class” setting displays. This allows a custom css to be used for the field.

  • default_value_setting
    Controls whether the “Default Values” section displays. This allows a value to be set for the field.

  • description_setting
    Controls whether the “Description” setting appears. This allows a description for the field to be displayed.

  • duplicate_setting
    Controls whether the “No Duplicates” setting displays within the “Rules” section. This controls whether the same value may exist more than once in the database. The “Rules” setting must be active for this to display.

  • error_message_setting
    Controls whether the “Custom Validation Message” setting which allows a custom message to be used appears.

  • label_setting
    Controls whether the “Field Label” setting which allows the label to be changed appears.

  • number_format_setting
    Determines whether the “Number Format” drop down displays. This setting allows the format of the number to be set from the choices of “Currency”, “9,999.99”, “9.999,99”.

  • placeholder_setting
    Controls whether the “Placeholders” section appears. This allows placeholder text to display for the field.

  • prepopulate_field_setting
    Controls whether the “Allow field to be populated dynamically” setting appears.

  • range_setting
    Determines whether the “Range” setting displays. This allows a minimum and maximum range to be set to ensure the number entered fits within the range.

  • rules_setting
    Controls whether the “Rules” settings section displays. The “Required” option shows when this is active.

  • size_setting
    Controls whether the “Field Size” setting displays. This controls the size of the input field for fields to which it applies. The sizes are “small”, “medium”, and “large”.

  • visibility_setting
    Controls whether the “Visibility” setting displays. The controls whether the option of visibility being for “Everyone” or “Admin Only” can be set.

Properties

Below is a listing of the properties inherited from the parent class and ones specific to the field.

  • adminLabel string

    The label to be used on admin pages instead of the label, useful for fields with long labels.

  • adminOnly boolean

    Determines whether the field is visible to the user submitting the form, or only visible in the admin.

  • allowsPrepopulate boolean

    Determines if the field values can be dynamically populated. Default is false.

  • calculationFormula string

    The formula used for the number field.

  • calculationRounding string

    Specifies to how many decimal places the number should be rounded. This is available when enableCalculation is true, but is not available when the chosen format is “Currency” or if this is a Quantity field of the Number type.

  • conditionalLogic array

    An associative array containing the conditional logic rules. See the Conditional Logic Object for more details.

  • cssClass string

    The custom CSS class or classes to be added to the input tag for the field.

  • defaultValue string

    The default value to be displayed in the field. If this is not changed, it is the value submitted.

  • description string

    The field description.

  • descriptionPlacement string

    The placement of the field description. The description may be placed “above” or “below” the field inputs. If the placement is not specified, then the description placement setting for the Form Layout is used.

  • enableCalculation boolean

    Indicates whether the number field is a calculation.

  • errorMessage string

    The custom error message to be displayed if the field fails validation.

  • formId integer

    The form ID.

  • id integer

    The field ID.

  • inputName string

    The parameter name used when dynamically populating the field.

  • inputType string

    This property is only available if the field is the Quantity field and of the Number type. This indicates the sub-type for the Quantity field. The value will be number, with the type property set to quantity.

  • isRequired boolean

    Marking the field as required will prevent the form from being submitted if the user does not enter a value. Default is false.

  • label string

    The field label that will be displayed on the form and on the admin pages.

  • noDuplicates boolean

    Determines if the value entered by the user may already exist in the database.

  • numberFormat string

    The format for the number. The choices are “currency”, “decimal_comma”, “decimal_dot”.

  • productField integer

    This is only available if it is a Quantity field of the Number type. The id of the product field to which the Quantity is associated.

  • rangeMax integer

    The maximum number the value may be. This is not available when enableCalculation is true.

  • rangeMin integer

    The minimum number the value may be. This is not available when enableCalculation is true.

  • size string

    Controls the width of the input field. The choices are “small”, “medium”, and “large”.

  • type string

    The field type. This is set to number, unless this field is a Quantity field that is of the Number type. In that instance, the type will be set to quantity.

##Source Code
The source code is located in includes/fields/class-gf-field-number.php in the Gravity Forms folder of your sites plugins directory.