com.sebtools.PhoneFormatter

Component PhoneFormatter (PhoneFormatter)

I ensure that phone numbers are in the correct format.


hierarchy: WEB-INF.cftags.component
      com.sebtools.PhoneFormatter
properties:
methods: init, fixPhoneNumber, fixPhoneNumbers, getProblemNumbers, PhoneFormat


init
public any init ( required any DataMgr, required any Format, string DefaultAreaCode="000" )

I initialize and return this component.

Output: suppressed
Parameters:
   DataMgr: any, required, DataMgr
   Format: any, required, Format
   DefaultAreaCode: string, optional, DefaultAreaCode

fixPhoneNumber
public string fixPhoneNumber ( required string phonenum, string areacode="[runtime expression]" )

I return the given phone number in the correct format.

Output: suppressed
Parameters:
   phonenum: string, required, phonenum - The phone number to be formatted.
   areacode: string, optional, areacode - The area code to use if none is present

fixPhoneNumbers
public void fixPhoneNumbers ( required string table, required string idfield, required string phonefield )

I fix all of the phone numbers in the given field of the given table.

Output: suppressed
Parameters:
   table: string, required, table - The table to correct
   idfield: string, required, idfield - The primary key field of the table (must be exactly one to work).
   phonefield: string, required, phonefield - The field holding the phone number (must not have other information).

getProblemNumbers
public query getProblemNumbers ( required string table, required string idfield, required string phonefield )

I get all of the phone numbers from the given table that are not formatted correctly (as well as the correct formatting for that phone number).

Output: suppressed
Parameters:
   table: string, required, table - The table to correct
   idfield: string, required, idfield - The primary key field of the table (must be exactly one to work).
   phonefield: string, required, phonefield - The field holding the phone number (must not have other information).

PhoneFormat
PhoneFormat ( required INPUT, required MASK )

Output: enabled
Parameters:
   INPUT: any, required, INPUT
   MASK: any, required, MASK