Difference between revisions of "Freeside:3:Documentation:Developer/FS/contact phone"

From Freeside
Jump to: navigation, search
m (Edit via perl MediaWiki framework (1.13))
m (Edit via perl MediaWiki framework (1.13))
 
Line 1: Line 1:
 +
==NAME==
 +
FS::contact_phone - Object methods for contact_phone records
  
 +
==SYNOPSIS==
 +
<code>
 +
  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;
 +
</code>
 +
==DESCRIPTION==
 +
An FS::contact_phone object represents a contatct's phone number. 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 phone number. To add the phone number to the database, see [[#insert|"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 phone number. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.
 +
 +
==BUGS==
 +
==SEE ALSO==
 +
[[Freeside:3:Documentation:Developer/FS/contact|FS::contact]], [[Freeside:3:Documentation:Developer/FS/Record|FS::Record]]

Latest revision as of 05:30, 10 February 2015

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 a contatct's phone number. 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 phone number. To add the phone number 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 phone number. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

BUGS

SEE ALSO

FS::contact, FS::Record

Retrieved from "http://freeside.biz/mediawiki/index.php?title=Freeside:3:Documentation:Developer/FS/contact_phone&oldid=8339"