summaryrefslogtreecommitdiff
path: root/FS/FS/part_event_condition_option.pm
blob: f1d1b6a159e17b105269a3c2a920bd374c0a44d8 (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::part_event_condition_option;

use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs );
use FS::option_Common;
use FS::part_event_condition;

@ISA = qw( FS::option_Common ); # FS::Record);

=head1 NAME

FS::part_event_condition_option - Object methods for part_event_condition_option records

=head1 SYNOPSIS

  use FS::part_event_condition_option;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_event_condition_option object represents an event condition option.
FS::part_event_condition_option inherits from FS::Record.  The following fields
are currently supported:

=over 4

=item optionnum - primary key

=item eventconditionnum - Event condition (see L<FS::part_event_condition>)

=item optionname - Option name

=item optionvalue - Option value

=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new record.  To add the record 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

# the new method can be inherited from FS::Record, if a table method is defined

sub table { 'part_event_condition_option'; }

=item insert [ HASHREF | OPTION => VALUE ... ]

Adds this record to the database.  If there is an error, returns the error,
otherwise returns false.

If a list or hash reference of options is supplied,
part_event_condition_option_option records are created (see
L<FS::part_event_condition_option_option>).

=cut

# the insert method can be inherited from FS::Record

=item delete

Delete this record from the database.

=cut

# the delete method can be inherited from FS::Record

=item replace OLD_RECORD [ HASHREF | OPTION => VALUE ... ]

Replaces the OLD_RECORD with this one in the database.  If there is an error,
returns the error, otherwise returns false.

If a list or hash reference of options is supplied,
part_event_condition_option_option records are created or modified (see
L<FS::part_event_condition_option_option>).

=cut

# the replace method can be inherited from FS::Record

=item check

Checks all fields to make sure this is a valid record.  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_numbern('optionnum')
    || $self->ut_foreign_key('eventconditionnum',
                               'part_event_condition', 'eventconditionnum')
    || $self->ut_text('optionname')
    || $self->ut_textn('optionvalue')
  ;
  return $error if $error;

  $self->SUPER::check;
}

#this makes the nested options magically show up as perl refs
#move it to a mixin class if we need nested options again
sub optionvalue {
  my $self = shift;
  if ( scalar(@_) ) { #setting, no magic (here, insert takes care of it)
    $self->set('optionvalue', @_);
  } else { #getting, magic
    my $optionvalue = $self->get('optionvalue');
    if ( $optionvalue eq 'HASH' ) {
      return { $self->options };
    } else {
      $optionvalue;
    }
  }
}

use FS::upgrade_journal;
sub _upgrade_data { #class method
  my ($class, %opts) = @_;

  # migrate part_event_condition_option agentnum to part_event_condition_option_option agentnum
  unless ( FS::upgrade_journal->is_done('agentnum_to_hash') ) {

    foreach my $condition_option (qsearch('part_event_condition_option', { optionname => 'agentnum', })) {
      my %options;
      my $optionvalue = $condition_option->get("optionvalue");
      if ($optionvalue eq 'HASH' ) { next; }
      elsif ($optionvalue eq '') {
        foreach my $agent (qsearch('agent', {})) {
          $options{$agent->agentnum} = '1';
        }

      }
      else {
        $options{$optionvalue} = '1';
      }

      $condition_option->optionvalue(ref(\%options));
      my $error = $condition_option->replace(\%options);
      die $error if $error;

    }

    FS::upgrade_journal->set_done('agentnum_to_hash');

  }

}

=back

=head1 SEE ALSO

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

=cut

1;