summaryrefslogtreecommitdiff
path: root/FS/FS/part_pkg_report_option.pm
blob: e3c353a2cdd4499a44cfb3e67e19d66d89f9c502 (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
package FS::part_pkg_report_option;

use strict;
use base qw( FS::Record );
use FS::Record qw( qsearch qsearchs dbh );

=head1 NAME

FS::part_pkg_report_option - Object methods for part_pkg_report_option records

=head1 SYNOPSIS

  use FS::part_pkg_report_option;

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

  $error = $record->insert;

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

  $error = $record->delete;

  $error = $record->check;

=head1 DESCRIPTION

An FS::part_pkg_report_option object represents a package definition optional
reporting classification.  FS::part_pkg_report_option inherits from
FS::Record.  The following fields are currently supported:

=over 4

=item num

primary key

=item name

name - The name associated with the reporting option

=item disabled

disabled - set to 'Y' to prevent addition to new packages


=back

=head1 METHODS

=over 4

=item new HASHREF

Creates a new report option.  To add the option 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 { 'part_pkg_report_option'; }

=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

sub delete {
  return "Can't delete part_pkg_report_option records!";
}

=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_numbern('num')
    || $self->ut_text('name')
    || $self->ut_enum('disabled', [ '', 'Y' ])
  ;
  return $error if $error;

  $self->SUPER::check;
}

=back

=head1 CLASS METHODS

=over 4

=item subsets OPTIONNUM, ...

Given a list of report_option numbers, determines all combinations of those
numbers that exist on actual package definitions.  For each such combination,
returns an arrayref of report_option numbers, followed by an arrayref of
corresponding report class names.  This is used for a search optimization.

=cut

# probably doesn't belong here, but there's not a better place for it
# and optimizations are, by nature, hackish

sub subsets {
  my ($self, @nums) = @_;
  my @optionnames = map { "'report_option_$_'" } @nums;
  my $where = "WHERE optionname IN(".join(',',@optionnames).")"
    if @nums;
  my $subselect =
    "SELECT pkgpart, replace(optionname, 'report_option_', '')::int AS num ".
    "FROM part_pkg_option $where ".
    "ORDER BY pkgpart, num";
  my $select =
    "SELECT DISTINCT array_to_string(array_agg(num), ','), ".
    "array_to_string(array_agg(name), ',') ".
    "FROM ($subselect) AS x JOIN part_pkg_report_option USING (num) ".
    "GROUP BY pkgpart";
  my $dbh = dbh;
  my $sth = $dbh->prepare($select)
    or die $dbh->errstr; # seriously, this should never happen
  $sth->execute
    or die $sth->errstr;
  # return a pair of entries for the null set (conventionally we use zero
  # for that)
  ( [ 0 ], [ '(empty class)' ],
  # followed by the first two columns: report class numbers and names
    map { [ split(',',$_->[0]) ],
          [ split(',',$_->[1]) ] } @{ $sth->fetchall_arrayref }
  );
}

=back

=head1 BUGS

Overlaps somewhat with pkg_class and pkg_category

=head1 SEE ALSO

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

=cut

1;