summaryrefslogtreecommitdiff
path: root/FS/FS/contact_phone.pm
blob: 46d6a9b6b6ab0c5e06bb26bf1765e5b755641f3b (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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
package FS::contact_phone;
use base qw( FS::Record );

use strict;

=head1 NAME

FS::contact_phone - Object methods for contact_phone records

=head1 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;

=head1 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:

=over 4

=item contactphonenum

primary key

=item contactnum

contactnum

=item phonetypenum

phonetypenum

=item countrycode

countrycode

=item phonenum

phonenum

=item extension

extension


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new phone number.  To add the phone number 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

sub table { 'contact_phone'; }

=item insert

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

=item delete

Delete this record from the database.

=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.

=item 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.

=cut

sub check {
  my $self = shift;

  my $error = 
    $self->ut_numbern('contactphonenum')
    || $self->ut_number('contactnum')
    || $self->ut_number('phonetypenum')
    || $self->ut_text('countrycode')
    || $self->ut_text('phonenum')
    || $self->ut_textn('extension')
  ;
  return $error if $error;

  #strip non-digits, UI should format numbers per countrycode
  (my $phonenum = $self->phonenum ) =~ s/\D//g;
  $self->phonenum($phonenum);

  $self->SUPER::check;
}

sub phonenum_pretty {
  my $self = shift;

  #until/unless we have the upgrade strip all whitespace
  (my $phonenum = $self->phonenum ) =~ s/\D//g;

  if ( $self->countrycode == 1 ) {

    $phonenum =~ /^(\d{3})(\d{3})(\d{4})(\d*)$/
      or return $self->phonenum; #wtf?

    $phonenum = "($1) $2-$3";
    $phonenum .= " x$4" if $4;
    return $phonenum;

  } else {
    warn "don't know how to format phone numbers for country +". $self->countrycode;
    #also, the UI doesn't have a good way for you to enter them yet or parse a countrycode from the number
    return $self->phonenum;
  }

}

sub typename {
  my $self = shift;
  $self->phone_type->typename;
}

=back

=head1 BUGS

=head1 SEE ALSO

L<FS::contact>, L<FS::Record>

=cut

1;