summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/part_referral.txt
blob: 534996323e262a617f5347aa87a74ea58077b907 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
NAME
    FS::part_referral - Object methods for part_referral objects

SYNOPSIS
      use FS::part_referral;

      $record = create FS::part_referral \%hash
      $record = create FS::part_referral { 'column' => 'value' };

      $error = $record->insert;

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

      $error = $record->delete;

      $error = $record->check;

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:

    refnum - primary key (assigned automatically for new referrals)
    referral - Text name of this referral
METHODS
    create HASHREF
        Creates a new referral. To add the referral to the database,
        see the section on "insert".

    insert
        Adds this referral to the database. If there is an error,
        returns the error, otherwise returns false.

    delete
        Currently unimplemented.

    replace OLD_RECORD
        Replaces 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 referral. If
        there is an error, returns the error, otherwise returns
        false. Called by the insert and replace methods.

BUGS
    It doesn't properly override FS::Record yet.

    The delete method is unimplemented.

SEE ALSO
    the FS::Record manpage, the FS::cust_main manpage, schema.html
    from the base documentation.

HISTORY
    Class dealing with referrals

    ivan@sisd.com 98-feb-23

    pod ivan@sisd.com 98-sep-21