summaryrefslogtreecommitdiff
path: root/FS/FS/reason.pm
blob: 5311ec5aa6892d3772ce8e6e4d5b85f1e4a4c76c (plain)
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
package FS::reason;

use strict;
use vars qw( @ISA $DEBUG $me );
use DBIx::DBSchema;
use DBIx::DBSchema::Table;
use DBIx::DBSchema::Column;
use FS::Record qw( qsearch qsearchs dbh dbdef );
use FS::reason_type;

@ISA = qw(FS::Record);
$DEBUG = 0;
$me = '[FS::reason]';

=head1 NAME

FS::reason - Object methods for reason records

=head1 SYNOPSIS

  use FS::reason;

  $record = new FS::reason \%hash;
  $record = new FS::reason { 'column' => 'value' };

  $error = $record->insert;

  $error = $new_record->replace($old_record);

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::reason object represents a reason message.  FS::reason inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item reasonnum - primary key

=item reason_type - index into FS::reason_type

=item reason - text of the reason

=item disabled - 'Y' or ''


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new reason.  To add the example 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 { 'reason'; }

=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 reason.  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('reasonnum')
    || $self->ut_text('reason')
  ;
  return $error if $error;

  $self->SUPER::check;
}

=item reasontype

Returns the reason_type (see <I>FS::reason_type</I>) associated with this reason.

=cut

sub reasontype {
  qsearchs( 'reason_type', { 'typenum' => shift->reason_type } );
}

# _upgrade_data
#
# Used by FS::Upgrade to migrate to a new database.
#
#

sub _upgrade_data {  # class method
  my ($self, %opts) = @_;
  my $dbh = dbh;

  warn "$me upgrading $self\n" if $DEBUG;

  my $column = dbdef->table($self->table)->column('reason');
  unless ($column->type eq 'text') { # assume history matches main table

    # ideally this would be supported in DBIx-DBSchema and friends
    warn "$me Shifting reason column to type 'text'\n" if $DEBUG;
    foreach my $table ( $self->table, 'h_'. $self->table ) {
      my @sql = ();

      $column = dbdef->table($self->table)->column('reason');
      my $columndef = $column->line($dbh);
      $columndef =~ s/varchar\(\d+\)/text/i;

      if ( $dbh->{Driver}->{Name} eq 'Pg' ) {

        my $notnull = $columndef =~ s/not null//i;
        push @sql,"ALTER TABLE $table RENAME reason TO freeside_upgrade_reason";
        push @sql,"ALTER TABLE $table ADD $columndef";
        push @sql,"UPDATE $table SET reason = freeside_upgrade_reason";
        push @sql,"ALTER TABLE $table ALTER reason SET NOT NULL"
          if $notnull;
        push @sql,"ALTER TABLE $table DROP freeside_upgrade_reason";

      } elsif ( $dbh->{Driver}->{Name} =~ /^mysql/i ){

        #crap, this isn't working
        #push @sql,"ALTER TABLE $table MODIFY reason ". $column->line($dbh);
        warn "WARNING: reason table upgrade not yet supported for mysql, sorry";

      } else {
        die "watchu talkin' 'bout, Willis? (unsupported database type)";
      }

      foreach (@sql) {
        my $sth = $dbh->prepare($_) or die $dbh->errstr;
        $sth->execute or die $sth->errstr;
      }
    }
  }

 '';

}
=back

=head1 BUGS

Here be termintes.  Don't use on wooden computers.

=head1 SEE ALSO

L<FS::Record>, schema.html from the base documentation.

=cut

1;