add customer fields option with agent, display_custnum, status and name, RT#73721
[freeside.git] / FS / FS / svc_acct_pop.pm
1 package FS::svc_acct_pop;
2
3 use strict;
4 use vars qw( @ISA @EXPORT_OK @svc_acct_pop %svc_acct_pop );
5 use FS::Record qw( qsearch qsearchs );
6
7 @ISA = qw( FS::Record Exporter );
8 @EXPORT_OK = qw( popselector );
9
10 =head1 NAME
11
12 FS::svc_acct_pop - Object methods for svc_acct_pop records
13
14 =head1 SYNOPSIS
15
16   use FS::svc_acct_pop;
17
18   $record = new FS::svc_acct_pop \%hash;
19   $record = new FS::svc_acct_pop { 'column' => 'value' };
20
21   $error = $record->insert;
22
23   $error = $new_record->replace($old_record);
24
25   $error = $record->delete;
26
27   $error = $record->check;
28
29   $html = FS::svc_acct_pop::popselector( $popnum, $state );
30
31 =head1 DESCRIPTION
32
33 An FS::svc_acct object represents an point of presence.  FS::svc_acct_pop
34 inherits from FS::Record.  The following fields are currently supported:
35
36 =over 4
37
38 =item popnum - primary key (assigned automatically for new accounts)
39
40 =item city
41
42 =item state
43
44 =item ac - area code
45
46 =item exch - exchange
47
48 =item loc - rest of number
49
50 =back
51
52 =head1 METHODS
53
54 =over 4
55
56 =item new HASHREF
57
58 Creates a new point of presence (if only it were that easy!).  To add the 
59 point of presence to the database, see L<"insert">.
60
61 =cut
62
63 sub table { 'svc_acct_pop'; }
64
65 =item insert
66
67 Adds this point of presence to the database.  If there is an error, returns the
68 error, otherwise returns false.
69
70 =item delete
71
72 Removes this point of presence from the database.
73
74 =item replace OLD_RECORD
75
76 Replaces OLD_RECORD with this one in the database.  If there is an error,
77 returns the error, otherwise returns false.
78
79 =item check
80
81 Checks all fields to make sure this is a valid point of presence.  If there is
82 an error, returns the error, otherwise returns false.  Called by the insert
83 and replace methods.
84
85 =cut
86
87 sub check {
88   my $self = shift;
89
90     $self->ut_numbern('popnum')
91       or $self->ut_text('city')
92       or $self->ut_text('state')
93       or $self->ut_number('ac')
94       or $self->ut_number('exch')
95       or $self->ut_numbern('loc')
96       or $self->SUPER::check
97   ;
98
99 }
100
101 =item text
102
103 Returns:
104
105 "$city, $state ($ac)/$exch"
106
107 =cut
108
109 sub text {
110   my $self = shift;
111   $self->city. ', '. $self->state.
112     ' ('. $self->ac. ')/'. $self->exch. '-'. $self->loc;
113 }
114
115 =back
116
117 =head1 SUBROUTINES
118
119 =over 4
120
121 =item popselector [ POPNUM [ STATE ] ]
122
123 =cut
124
125 #horrible false laziness with signup.cgi (pull special-case for 0 & 1
126 # pop code out from signup.cgi??)
127 sub popselector {
128   my( $popnum, $state ) = @_;
129
130   unless ( @svc_acct_pop ) { #cache pop list
131     @svc_acct_pop = qsearch('svc_acct_pop', {} );
132     %svc_acct_pop = ();
133     push @{$svc_acct_pop{$_->state}}, $_ foreach @svc_acct_pop;
134   }
135
136   my $text = <<END;
137     <SCRIPT>
138     function opt(what,href,text) {
139       var optionName = new Option(text, href, false, false)
140       var length = what.length;
141       what.options[length] = optionName;
142     }
143     
144     function popstate_changed(what) {
145       state = what.options[what.selectedIndex].text;
146       what.form.popnum.options.length = 0
147       what.form.popnum.options[0] = new Option("", "", false, true);
148 END
149
150   foreach my $popstate ( sort { $a cmp $b } keys %svc_acct_pop ) {
151     $text .= "\nif ( state == \"$popstate\" ) {\n";
152
153     foreach my $pop ( @{$svc_acct_pop{$popstate}}) {
154       my $o_popnum = $pop->popnum;
155       my $poptext = $pop->text;
156       $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n"
157     }
158     $text .= "}\n";
159   }
160
161   $text .= "}\n</SCRIPT>\n";
162
163   $text .=
164     qq!<SELECT NAME="popstate" SIZE=1 onChange="popstate_changed(this)">!.
165     qq!<OPTION> !;
166   $text .= "<OPTION>$_" foreach sort { $a cmp $b } keys %svc_acct_pop;
167   $text .= '</SELECT>'; #callback? return 3 html pieces?  #'</TD><TD>';
168
169   $text .= qq!<SELECT NAME="popnum" SIZE=1><OPTION> !;
170   my @initial_select;
171   if ( scalar(@svc_acct_pop) > 100 ) {
172     @initial_select = qsearchs( 'svc_acct_pop', { 'popnum' => $popnum } );
173   } else {
174     @initial_select = @svc_acct_pop;
175   }
176   foreach my $pop ( @initial_select ) {
177     $text .= qq!<OPTION VALUE="!. $pop->popnum. '"'.
178              ( ( $popnum && $pop->popnum == $popnum ) ? ' SELECTED' : '' ). ">".
179              $pop->text;
180   }
181   $text .= '</SELECT>';
182
183   $text;
184
185 }
186
187 =back
188
189 =head1 BUGS
190
191 It should be renamed to part_pop.
192
193 popselector?  putting web ui components in here?  they should probably live
194 somewhere else...  
195
196 popselector: pull special-case for 0 & 1 pop code out from signup.cgi
197
198 =head1 SEE ALSO
199
200 L<FS::Record>, L<FS::svc_acct>, L<FS::part_pop_local>, schema.html from the
201 base documentation.
202
203 =cut
204
205 1;
206