Freeside:3:Documentation:Developer/FS/contact phone

From Freeside
< Freeside:3:Documentation:Developer‎ | FS
Revision as of 21:03, 27 June 2012 by Ivan (talk | contribs) (Edit via perl MediaWiki framework (1.13))

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

NAME

FS::contact_phone - Object methods for contact_phone records

SYNOPSIS

 use FS::contact_phone;

 $record = new FS::contact_phone \%hash;
 $record = new FS::contact_phone { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::contact_phone object represents an example. FS::contact_phone inherits from FS::Record. The following fields are currently supported:

contactphonenum
primary key
contactnum
contactnum
phonetypenum
phonetypenum
countrycode
countrycode
phonenum
phonenum
extension
extension

METHODS

new HASHREF
Creates a new example. To add the example to the database, see "insert".
Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.
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.

BUGS

The author forgot to customize this manpage.

SEE ALSO

FS::Record, schema.html from the base documentation.