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

Revision as of 20:03, 27 June 2012

NAME

FS::contact - Object methods for contact records

SYNOPSIS

 use FS::contact;

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

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

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

contactnum

primary key

prospectnum

prospectnum

custnum

custnum

locationnum

locationnum

last

last

first

first

title

title

comment

comment

disabled

disabled

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

SEE ALSO

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