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
|
package FS::phone_type;
use base qw( FS::Record );
use strict;
use FS::Record qw( qsearch ); # qsearchs );
=head1 NAME
FS::phone_type - Object methods for phone_type records
=head1 SYNOPSIS
use FS::phone_type;
$record = new FS::phone_type \%hash;
$record = new FS::phone_type { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::phone_type object represents an phone number type (for example: Work,
Home, Mobile, Fax). FS::phone_type inherits from FS::Record. The following
fields are currently supported:
=over 4
=item phonetypenum
Primary key
=item typename
Type name
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new type. To add the type 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 { 'phone_type'; }
=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 type. 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('phonetypenum')
|| $self->ut_number('weight')
|| $self->ut_text('typename')
;
return $error if $error;
$self->SUPER::check;
}
=item get_phone_types
returns a list of phone_types.
=cut
sub get_phone_types {
## not using Home and Fax right now. false laziness with /elements/contact.html
my @phone_types = qsearch({table=>'phone_type', order_by=>'ORDER BY weight DESC', extra_sql => " WHERE typename NOT IN ('Home','Fax')"});
return @phone_types;
}
# Used by FS::Setup to initialize a new database.
sub _populate_initial_data {
my ($class, %opts) = @_;
my $weight = 10;
foreach ("Work", "Home", "Mobile", "Fax") {
my $object = $class->new({ 'typename' => $_,
'weight' => $weight,
});
my $error = $object->insert;
die "error inserting $class into database: $error\n"
if $error;
$weight += 10;
}
'';
}
# Used by FS::Upgrade to migrate to a new database.
sub _upgrade_data {
my $class = shift;
return $class->_populate_initial_data(@_)
unless scalar( qsearch( 'phone_type', {} ) );
'';
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::contact_phone>, L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
