|
|
| Line 1: |
Line 1: |
| − | ==NAME==
| |
| − | FS::areacode - Object methods for areacode records
| |
| | | | |
| − | ==SYNOPSIS==
| |
| − | <code>
| |
| − | use FS::areacode;
| |
| − |
| |
| − | $record = new FS::areacode \%hash;
| |
| − | $record = new FS::areacode { 'column' => 'value' };
| |
| − |
| |
| − | $error = $record->insert;
| |
| − |
| |
| − | $error = $new_record->replace($old_record);
| |
| − |
| |
| − | $error = $record->delete;
| |
| − |
| |
| − | $error = $record->check;
| |
| − | </code>
| |
| − | ==DESCRIPTION==
| |
| − | An FS::areacode object represents an area code. FS::areacode inherits from FS::Record. The following fields are currently supported:
| |
| − |
| |
| − | ; areanum - primary key; code - area code; country - two-letter country code; state - two-letter state code, if appropriate; description - description (optional)
| |
| − | ==METHODS==
| |
| − | ; insert
| |
| − | :Adds this record to the database. If there is an error, returns the error, otherwise returns false.
| |
| − | ; delete
| |
| − | :Delete this record from the database.
| |
| − | ; replace OLD_RECORD
| |
| − | :Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.
| |
| − | ; check
| |
| − | :Checks all fields to make sure this is a valid example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
| |
| − |
| |
| − | ==CLASS METHODS==
| |
| − | locate CODE
| |
| − |
| |
| − | Returns the country, state, and description for an area code.
| |
| − |
| |
| − | ==SEE ALSO==
| |
| − | [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]], schema.html from the base documentation.
| |
