X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_referral.pm;h=b12cd628e6cbd052f39e2a57e502582b13a7d067;hb=264ad081e68057c7bc30a8b2ad741b783e1342ff;hp=3f0af4b8e0b57838cd0e2b536b8948e7cdfd9d1f;hpb=6cd87c0d3b5280446301c647fa5f1ec5a593fa3f;p=freeside.git diff --git a/FS/FS/part_referral.pm b/FS/FS/part_referral.pm index 3f0af4b8e..b12cd628e 100644 --- a/FS/FS/part_referral.pm +++ b/FS/FS/part_referral.pm @@ -2,7 +2,8 @@ package FS::part_referral; use strict; use vars qw( @ISA ); -use FS::Record; +use FS::Record qw(qsearchs); +use FS::agent; @ISA = qw( FS::Record ); @@ -27,26 +28,36 @@ FS::part_referral - Object methods for part_referral objects =head1 DESCRIPTION -An FS::part_referral represents a referral - where a customer heard of your -services. This can be used to track the effectiveness of a particular piece of -advertising, for example. FS::part_referral inherits from FS::Record. The -following fields are currently supported: +An FS::part_referral represents a advertising source - where a customer heard +of your services. This can be used to track the effectiveness of a particular +piece of advertising, for example. FS::part_referral inherits from FS::Record. +The following fields are currently supported: =over 4 =item refnum - primary key (assigned automatically for new referrals) -=item referral - Text name of this referral +=item referral - Text name of this advertising source + +=item disabled - Disabled flag, empty or 'Y' + +=item agentnum - Optional agentnum (see L) =back +=head1 NOTE + +These were called B before version 1.4.0 - the name was changed +so as not to be confused with the new customer-to-customer referrals. + =head1 METHODS =over 4 =item new HASHREF -Creates a new referral. To add the referral to the database, see L<"insert">. +Creates a new advertising source. To add the referral to the database, see +L<"insert">. =cut @@ -54,8 +65,8 @@ sub table { 'part_referral'; } =item insert -Adds this referral to the database. If there is an error, returns the error, -otherwise returns false. +Adds this advertising source to the database. If there is an error, returns +the error, otherwise returns false. =item delete @@ -76,30 +87,47 @@ returns the error, otherwise returns false. =item check -Checks all fields to make sure this is a valid referral. If there is an error, -returns the error, otherwise returns false. Called by the insert and replace -methods. +Checks all fields to make sure this is a valid advertising source. If there is +an error, returns the error, otherwise returns false. Called by the insert and +replace methods. =cut sub check { my $self = shift; - $self->ut_numbern('refnum') + my $error = $self->ut_numbern('refnum') || $self->ut_text('referral') + || $self->ut_enum('disabled', [ '', 'Y' ] ) + #|| $self->ut_foreign_keyn('agentnum', 'agent', 'agentnum') + || $self->ut_agentnum_acl('agentnum', 'Edit global advertising sources') ; + return $error if $error; + + $self->SUPER::check; } -=back +=item agent -=head1 VERSION +Returns the associated agent for this referral, if any, as an FS::agent object. -$Id: part_referral.pm,v 1.1 1999-08-04 09:03:53 ivan Exp $ +=cut + +sub agent { + my $self = shift; + qsearchs('agent', { 'agentnum' => $self->agentnum } ); +} + +=back =head1 BUGS The delete method is unimplemented. +`Advertising source'. Yes, it's a sucky name. The only other ones I could +come up with were "Marketing channel" and "Heard Abouts" and those are +definately both worse. + =head1 SEE ALSO L, L, schema.html from the base documentation.