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
|
package FS::areacode;
use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs );
=head1 NAME
FS::areacode - Object methods for areacode records
=head1 SYNOPSIS
use FS::areacode;
$record = new FS::areacode \%hash;
$record = new FS::areacode { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::areacode object represents an example. FS::areacode inherits from
FS::Record. The following fields are currently supported:
=over 4
=item code
area code (primary key)
=item country
two-letter country code
=item state
two-letter state code, if appropriate
=item description
description (optional)
=back
=head1 METHODS
=over 4
=cut
sub table { 'areacode'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=cut
=item delete
Delete this record from the database.
=cut
=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
=item check
Checks all fields to make sure this is a valid example. 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_number('code')
|| $self->ut_text('country')
|| $self->ut_textn('state')
|| $self->ut_textn('description')
;
return $error if $error;
$self->SUPER::check;
}
=back
=head1 CLASS METHODS
locate CODE
Returns the country, state, and description for an area code.
=cut
sub locate {
my $class = shift;
my $code = shift;
my $areacode = qsearchs('areacode', { code => $code })
or return ();
return ($areacode->country, $areacode->state, $areacode->description);
}
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
