FS/FS/cust_main_county.pm

   1 package FS::cust_main_county;
   2
   3 use strict;
   4 use vars qw( @ISA @EXPORT_OK $conf
   5              @cust_main_county %cust_main_county $countyflag );
   6 use Exporter;
   7 use FS::Record qw( qsearch );
   8
   9 @ISA = qw( FS::Record );
  10 @EXPORT_OK = qw( regionselector );
  11
  12 @cust_main_county = ();
  13 $countyflag = '';
  14
  15 #ask FS::UID to run this stuff for us later
  16 $FS::UID::callback{'FS::cust_main_county'} = sub {
  17   $conf = new FS::Conf;
  18 };
  19
  20 =head1 NAME
  21
  22 FS::cust_main_county - Object methods for cust_main_county objects
  23
  24 =head1 SYNOPSIS
  25
  26   use FS::cust_main_county;
  27
  28   $record = new FS::cust_main_county \%hash;
  29   $record = new FS::cust_main_county { 'column' => 'value' };
  30
  31   $error = $record->insert;
  32
  33   $error = $new_record->replace($old_record);
  34
  35   $error = $record->delete;
  36
  37   $error = $record->check;
  38
  39   ($county_html, $state_html, $country_html) =
  40     FS::cust_main_county::regionselector( $county, $state, $country );
  41
  42 =head1 DESCRIPTION
  43
  44 An FS::cust_main_county object represents a tax rate, defined by locale.
  45 FS::cust_main_county inherits from FS::Record.  The following fields are
  46 currently supported:
  47
  48 =over 4
  49
  50 =item taxnum - primary key (assigned automatically for new tax rates)
  51
  52 =item state
  53
  54 =item county
  55
  56 =item country
  57
  58 =item tax - percentage
  59
  60 =item taxclass
  61
  62 =item exempt_amount
  63
  64 =item taxname - if defined, printed on invoices instead of "Tax"
  65
  66 =item setuptax - if 'Y', this tax does not apply to setup fees
  67
  68 =item recurtax - if 'Y', this tax does not apply to recurring fees
  69
  70 =back
  71
  72 =head1 METHODS
  73
  74 =over 4
  75
  76 =item new HASHREF
  77
  78 Creates a new tax rate.  To add the tax rate to the database, see L<"insert">.
  79
  80 =cut
  81
  82 sub table { 'cust_main_county'; }
  83
  84 =item insert
  85
  86 Adds this tax rate to the database.  If there is an error, returns the error,
  87 otherwise returns false.
  88
  89 =item delete
  90
  91 Deletes this tax rate from the database.  If there is an error, returns the
  92 error, otherwise returns false.
  93
  94 =item replace OLD_RECORD
  95
  96 Replaces the OLD_RECORD with this one in the database.  If there is an error,
  97 returns the error, otherwise returns false.
  98
  99 =item check
 100
 101 Checks all fields to make sure this is a valid tax rate.  If there is an error,
 102 returns the error, otherwise returns false.  Called by the insert and replace
 103 methods.
 104
 105 =cut
 106
 107 sub check {
 108   my $self = shift;
 109
 110   $self->exempt_amount(0) unless $self->exempt_amount;
 111
 112   $self->ut_numbern('taxnum')
 113     || $self->ut_anything('state')
 114     || $self->ut_textn('county')
 115     || $self->ut_text('country')
 116     || $self->ut_float('tax')
 117     || $self->ut_textn('taxclass') # ...
 118     || $self->ut_money('exempt_amount')
 119     || $self->ut_textn('taxname')
 120     || $self->ut_enum('setuptax', [ '', 'Y' ] )
 121     || $self->ut_enum('recurtax', [ '', 'Y' ] )
 122     || $self->SUPER::check
 123     ;
 124
 125 }
 126
 127 sub taxname {
 128   my $self = shift;
 129   if ( $self->dbdef_table->column('taxname') ) {
 130     return $self->setfield('taxname', $_[0]) if @_;
 131     return $self->getfield('taxname');
 132   }
 133   return '';
 134 }
 135
 136 sub setuptax {
 137   my $self = shift;
 138   if ( $self->dbdef_table->column('setuptax') ) {
 139     return $self->setfield('setuptax', $_[0]) if @_;
 140     return $self->getfield('setuptax');
 141   }
 142   return '';
 143 }
 144
 145 sub recurtax {
 146   my $self = shift;
 147   if ( $self->dbdef_table->column('recurtax') ) {
 148     return $self->setfield('recurtax', $_[0]) if @_;
 149     return $self->getfield('recurtax');
 150   }
 151   return '';
 152 }
 153
 154 =back
 155
 156 =head1 SUBROUTINES
 157
 158 =over 4
 159
 160 =item regionselector [ COUNTY STATE COUNTRY [ PREFIX [ ONCHANGE ] ] ]
 161
 162 =cut
 163
 164 sub regionselector {
 165   my ( $selected_county, $selected_state, $selected_country,
 166        $prefix, $onchange ) = @_;
 167
 168   $prefix = '' unless defined $prefix;
 169
 170   $countyflag = 0;
 171
 172 #  unless ( @cust_main_county ) { #cache
 173     @cust_main_county = qsearch('cust_main_county', {} );
 174     foreach my $c ( @cust_main_county ) {
 175       $countyflag=1 if $c->county;
 176       #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
 177       $cust_main_county{$c->country}{$c->state}{$c->county} = 1;
 178     }
 179 #  }
 180   $countyflag=1 if $selected_county;
 181
 182   my $script_html = <<END;
 183     <SCRIPT>
 184     function opt(what,value,text) {
 185       var optionName = new Option(text, value, false, false);
 186       var length = what.length;
 187       what.options[length] = optionName;
 188     }
 189     function ${prefix}country_changed(what) {
 190       country = what.options[what.selectedIndex].text;
 191       for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
 192           what.form.${prefix}state.options[i] = null;
 193 END
 194       #what.form.${prefix}state.options[0] = new Option('', '', false, true);
 195
 196   foreach my $country ( sort keys %cust_main_county ) {
 197     $script_html .= "\nif ( country == \"$country\" ) {\n";
 198     foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 199       my $text = $state || '(n/a)';
 200       $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
 201     }
 202     $script_html .= "}\n";
 203   }
 204
 205   $script_html .= <<END;
 206     }
 207     function ${prefix}state_changed(what) {
 208 END
 209
 210   if ( $countyflag ) {
 211     $script_html .= <<END;
 212       state = what.options[what.selectedIndex].text;
 213       country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
 214       for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
 215           what.form.${prefix}county.options[i] = null;
 216 END
 217
 218     foreach my $country ( sort keys %cust_main_county ) {
 219       $script_html .= "\nif ( country == \"$country\" ) {\n";
 220       foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
 221         $script_html .= "\nif ( state == \"$state\" ) {\n";
 222           #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
 223           foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
 224             my $text = $county || '(n/a)';
 225             $script_html .=
 226               qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
 227           }
 228         $script_html .= "}\n";
 229       }
 230       $script_html .= "}\n";
 231     }
 232   }
 233
 234   $script_html .= <<END;
 235     }
 236     </SCRIPT>
 237 END
 238
 239   my $county_html = $script_html;
 240   if ( $countyflag ) {
 241     $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$onchange">!;
 242     $county_html .= '</SELECT>';
 243   } else {
 244     $county_html .=
 245       qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$selected_county">!;
 246   }
 247
 248   my $state_html = qq!<SELECT NAME="${prefix}state" !.
 249                    qq!onChange="${prefix}state_changed(this); $onchange">!;
 250   foreach my $state ( sort keys %{ $cust_main_county{$selected_country} } ) {
 251     my $text = $state || '(n/a)';
 252     my $selected = $state eq $selected_state ? 'SELECTED' : '';
 253     $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
 254   }
 255   $state_html .= '</SELECT>';
 256
 257   $state_html .= '</SELECT>';
 258
 259   my $country_html = qq!<SELECT NAME="${prefix}country" !.
 260                      qq!onChange="${prefix}country_changed(this); $onchange">!;
 261   my $countrydefault = $conf->config('countrydefault') || 'US';
 262   foreach my $country (
 263     sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
 264       keys %cust_main_county
 265   ) {
 266     my $selected = $country eq $selected_country ? ' SELECTED' : '';
 267     $country_html .= "\n<OPTION$selected>$country</OPTION>"
 268   }
 269   $country_html .= '</SELECT>';
 270
 271   ($county_html, $state_html, $country_html);
 272
 273 }
 274
 275 =back
 276
 277 =head1 BUGS
 278
 279 regionselector?  putting web ui components in here?  they should probably live
 280 somewhere else...
 281
 282 =head1 SEE ALSO
 283
 284 L<FS::Record>, L<FS::cust_main>, L<FS::cust_bill>, schema.html from the base
 285 documentation.
 286
 287 =cut
 288
 289 1;
 290