summaryrefslogtreecommitdiff
path: root/FS/FS/contact.pm
diff options
context:
space:
mode:
Diffstat (limited to 'FS/FS/contact.pm')
-rw-r--r--FS/FS/contact.pm177
1 files changed, 177 insertions, 0 deletions
diff --git a/FS/FS/contact.pm b/FS/FS/contact.pm
new file mode 100644
index 0000000..d3ab411
--- /dev/null
+++ b/FS/FS/contact.pm
@@ -0,0 +1,177 @@
+package FS::contact;
+
+use strict;
+use base qw( FS::Record );
+use FS::Record qw( qsearch qsearchs );
+use FS::prospect_main;
+use FS::cust_main;
+use FS::cust_location;
+
+=head1 NAME
+
+FS::contact - Object methods for contact records
+
+=head1 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;
+
+=head1 DESCRIPTION
+
+An FS::contact object represents an example. FS::contact inherits from
+FS::Record. The following fields are currently supported:
+
+=over 4
+
+=item contactnum
+
+primary key
+
+=item prospectnum
+
+prospectnum
+
+=item custnum
+
+custnum
+
+=item locationnum
+
+locationnum
+
+=item last
+
+last
+
+=item first
+
+first
+
+=item title
+
+title
+
+=item comment
+
+comment
+
+=item disabled
+
+disabled
+
+
+=back
+
+=head1 METHODS
+
+=over 4
+
+=item new HASHREF
+
+Creates a new example. To add the example to the database, see L<"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 I<hash> method.
+
+=cut
+
+# the new method can be inherited from FS::Record, if a table method is defined
+
+sub table { 'contact'; }
+
+=item insert
+
+Adds this record to the database. If there is an error, returns the error,
+otherwise returns false.
+
+=cut
+
+# the insert method can be inherited from FS::Record
+
+=item delete
+
+Delete this record from the database.
+
+=cut
+
+# the delete method can be inherited from FS::Record
+
+=item replace OLD_RECORD
+
+Replaces the OLD_RECORD with this one in the database. If there is an error,
+returns the error, otherwise returns false.
+
+=cut
+
+# the replace method can be inherited from FS::Record
+
+=item 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.
+
+=cut
+
+# the check method should currently be supplied - FS::Record contains some
+# data checking routines
+
+sub check {
+ my $self = shift;
+
+ my $error =
+ $self->ut_numbern('contactnum')
+ || $self->ut_foreign_keyn('prospectnum', 'prospect_main', 'prospectnum')
+ || $self->ut_foreign_keyn('custnum', 'cust_main', 'custnum')
+ || $self->ut_foreign_keyn('locationnum', 'cust_location', 'locationnum')
+ || $self->ut_textn('last')
+ || $self->ut_textn('first')
+ || $self->ut_textn('title')
+ || $self->ut_textn('comment')
+ || $self->ut_enum('disabled', [ '', 'Y' ])
+ ;
+ return $error if $error;
+
+ return "No prospect or customer!" unless $self->prospectnum || $self->custnum;
+ return "Prospect and customer!" if $self->prospectnum && $self->custnum;
+
+ return "One of first name, last name, or title must have a value"
+ if ! grep $self->$_(), qw( first last title);
+
+ $self->SUPER::check;
+}
+
+sub line {
+ my $self = shift;
+ my $data = $self->first. ' '. $self->last;
+ $data .= ', '. $self->title
+ if $self->title;
+ $data .= ' ('. $self->comment. ')'
+ if $self->comment;
+ $data;
+}
+
+=back
+
+=head1 BUGS
+
+The author forgot to customize this manpage.
+
+=head1 SEE ALSO
+
+L<FS::Record>, schema.html from the base documentation.
+
+=cut
+
+1;
+