HomeDocumentationTutorialsIncluding a telephone number field in my form

Including a telephone number field in my form

Overview

In this tutorial, we'll cover how to add a telephone field to your forms. This method allows you to integrate telephone inputs seamlessly into your application forms. This method takes three parameters:

 

  • field_name: The name attribute for the telephone  input.
  • field_label: The label that will be displayed alongside the telephone  input.
  • $required: An optional parameter (default is 0) that specifies whether the telephone input is required (1) or not (0).

 

This example shows how to add a telephone  field.

 

PHP
 // Adding a required telephone field
$objConfig->telephone('field_name', 'field_label', $required = 1);

 

Configuring the Maximum Number of Digits

To ensure that the telephone number does not exceed a certain number of digits, you can chain the max method after the telephone method. This example shows how to add a telephone field that expects a maximum of 10 digits.

 

PHP
// Adding a telephone field with a maximum of 10 digits
$objConfig->telephone('field_name', 'field_label', $required = 1)->max(10);

 

Configuration in Your Application

For the configuration to work properly, it's important to include the 'field_name'  amongst the `addFields` and `editFields`. This ensures that the fields are correctly initialized and integrated into your form. This example shows how to configure the add and edit fields.

 

PHP
// Adding your telephone field to the add and edit forms
$objConfig->addFields(array('field_name'));
$objConfig->editFields(array('field_name'));

 

Conclusion

By following these steps, you can easily integrate telephone fields into your PHP forms using $objConfig->telephone('field_name', 'field_label', $required = 0);. We also covered how to configure the maximum number of digits for the telephone field using $objConfig->telephone('field_name', 'field_label', $required = 0)->max(10);.