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
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
package FS::agent_type;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch dbh );
use FS::m2m_Common;
use FS::agent;
use FS::type_pkgs;
@ISA = qw( FS::m2m_Common FS::Record );
=head1 NAME
FS::agent_type - Object methods for agent_type records
=head1 SYNOPSIS
use FS::agent_type;
$record = new FS::agent_type \%hash;
$record = new FS::agent_type { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
$hashref = $record->pkgpart_hashref;
#may purchase $pkgpart if $hashref->{$pkgpart};
@type_pkgs = $record->type_pkgs;
@pkgparts = $record->pkgpart;
=head1 DESCRIPTION
An FS::agent_type object represents an agent type. Every agent (see
L<FS::agent>) has an agent type. Agent types define which packages (see
L<FS::part_pkg>) may be purchased by customers (see L<FS::cust_main>), via
FS::type_pkgs records (see L<FS::type_pkgs>). FS::agent_type inherits from
FS::Record. The following fields are currently supported:
=over 4
=item typenum
primary key (assigned automatically for new agent types)
=item atype
Text name of this agent type
=item disabled
Disabled flag, empty or 'Y'
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new agent type. To add the agent type to the database, see
L<"insert">.
=cut
sub table { 'agent_type'; }
=item insert
Adds this agent type to the database. If there is an error, returns the error,
otherwise returns false.
=item delete
Deletes this agent type from the database. Only agent types with no agents
can be deleted. If there is an error, returns the error, otherwise returns
false.
=cut
sub delete {
my $self = shift;
return "Can't delete an agent_type with agents!"
if qsearch( 'agent', { 'typenum' => $self->typenum } );
$self->SUPER::delete;
}
=item replace OLD_RECORD
Replaces OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=item check
Checks all fields to make sure this is a valid agent type. If there is an
error, returns the error, otherwise returns false. Called by the insert and
replace methods.
=cut
sub check {
my $self = shift;
$self->ut_numbern('typenum')
|| $self->ut_text('atype')
|| $self->ut_enum('disabled', [ '', 'Y' ] )
|| $self->SUPER::check;
}
=item pkgpart_hashref
Returns a hash reference. The keys of the hash are pkgparts. The value is
true iff this agent may purchase the specified package definition. See
L<FS::part_pkg>.
=cut
sub pkgpart_hashref {
my $self = shift;
my %pkgpart;
$pkgpart{$_}++ foreach $self->pkgpart;
\%pkgpart;
}
=item type_pkgs
Returns all FS::type_pkgs objects (see L<FS::type_pkgs>) for this agent type.
=cut
sub type_pkgs {
my $self = shift;
qsearch('type_pkgs', { 'typenum' => $self->typenum } );
}
=item type_pkgs_enabled
Returns all FS::type_pkg objects (see L<FS::type_pkgs>) that link to enabled
package definitions (see L<FS::part_pkg>).
An additional strange feature is that the returned type_pkg objects also have
all fields of the associated part_pkg object.
=cut
sub type_pkgs_enabled {
my $self = shift;
qsearch({
'table' => 'type_pkgs',
'addl_from' => 'JOIN part_pkg USING ( pkgpart )',
'hashref' => { 'typenum' => $self->typenum },
'extra_sql' => " AND ( disabled = '' OR disabled IS NULL )".
" ORDER BY pkg",
});
}
=item pkgpart
Returns the pkgpart of all package definitions (see L<FS::part_pkg>) for this
agent type.
=cut
sub pkgpart {
my $self = shift;
#map $_->pkgpart, $self->type_pkgs;
my $sql = 'SELECT pkgpart FROM type_pkgs WHERE typenum = ?';
my $sth = dbh->prepare($sql) or die dbh->errstr;
$sth->execute( $self->typenum ) or die $sth->errstr;
map $_->[0], @{ $sth->fetchall_arrayref };
}
=back
=head1 BUGS
type_pkgs_enabled should order itself by something (pkg?)
type_pkgs_enabled should populate something that caches for the part_pkg method
rather than add fields to this object, right? In fact we need a "poop" object
framework that does that automatically for any joined search at some point....
right?
=head1 SEE ALSO
L<FS::Record>, L<FS::agent>, L<FS::type_pkgs>, L<FS::cust_main>,
L<FS::part_pkg>, schema.html from the base documentation.
=cut
1;
|
