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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
|
package FS::svc_phone;
use strict;
use vars qw( @ISA );
#use FS::Record qw( qsearch qsearchs );
use FS::svc_Common;
@ISA = qw( FS::svc_Common );
=head1 NAME
FS::svc_phone - Object methods for svc_phone records
=head1 SYNOPSIS
use FS::svc_phone;
$record = new FS::svc_phone \%hash;
$record = new FS::svc_phone { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
$error = $record->suspend;
$error = $record->unsuspend;
$error = $record->cancel;
=head1 DESCRIPTION
An FS::svc_phone object represents a phone number. FS::svc_phone inherits
from FS::Record. The following fields are currently supported:
=over 4
=item svcnum - primary key
=item countrycode -
=item phonenum -
=item pin -
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new phone number. To add the 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
# the new method can be inherited from FS::Record, if a table method is defined
#
sub table_info {
{
'name' => 'Phone number',
'sorts' => 'phonenum',
'display_weight' => 60,
'cancel_weight' => 80,
'fields' => {
'countrycode' => { label => 'Country code',
type => 'text',
disable_inventory => 1,
disable_select => 1,
},
'phonenum' => 'Phone number',
'pin' => { label => 'Personal Identification Number',
type => 'text',
disable_inventory => 1,
disable_select => 1,
},
},
};
}
sub table { 'svc_phone'; }
=item search_sql STRING
Class method which returns an SQL fragment to search for the given string.
=cut
sub search_sql {
my( $class, $string ) = @_;
$class->search_sql_field('phonenum', $string );
}
=item label
Returns the phone number.
=cut
sub label {
my $self = shift;
$self->phonenum; #XXX format it better
}
=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 suspend
Called by the suspend method of FS::cust_pkg (see L<FS::cust_pkg>).
=item unsuspend
Called by the unsuspend method of FS::cust_pkg (see L<FS::cust_pkg>).
=item cancel
Called by the cancel method of FS::cust_pkg (see L<FS::cust_pkg>).
=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
# the check method should currently be supplied - FS::Record contains some
# data checking routines
sub check {
my $self = shift;
my $error =
$self->ut_numbern('svcnum')
|| $self->ut_numbern('countrycode')
|| $self->ut_number('phonenum')
|| $self->ut_numbern('pin')
;
return $error if $error;
$self->countrycode(1) unless $self->countrycode;
$self->SUPER::check;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::svc_Common>, L<FS::Record>, L<FS::cust_svc>, L<FS::part_svc>,
L<FS::cust_pkg>, schema.html from the base documentation.
=cut
1;
|