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
|
package FS::inventory_class;
use strict;
use vars qw( @ISA );
use FS::Record qw( dbh qsearch qsearchs );
@ISA = qw(FS::Record);
=head1 NAME
FS::inventory_class - Object methods for inventory_class records
=head1 SYNOPSIS
use FS::inventory_class;
$record = new FS::inventory_class \%hash;
$record = new FS::inventory_class { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::inventory_class object represents a class of inventory, such as "DID
numbers" or "physical equipment serials". FS::inventory_class inherits from
FS::Record. The following fields are currently supported:
=over 4
=item classnum - primary key
=item classname - Name of this class
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new inventory class. To add the class 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 { 'inventory_class'; }
=item insert
Adds this record to the database. If there is an error, returns the error,
otherwise returns false.
=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
Replaces the OLD_RECORD with this one in the database. If there is an error,
returns the error, otherwise returns false.
=cut
# the replace method can be inherited from FS::Record
=item check
Checks all fields to make sure this is a valid inventory class. 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('classnum')
|| $self->ut_textn('classname')
;
return $error if $error;
$self->SUPER::check;
}
=item num_avail
Returns the number of available (unused/unallocated) inventory items of this
class (see L<FS::inventory_item>).
=cut
sub num_avail {
shift->num_sql('( svcnum IS NULL OR svcnum = 0 )');
}
sub num_sql {
my( $self, $sql ) = @_;
$sql = "AND $sql" if length($sql);
my $statement =
"SELECT COUNT(*) FROM inventory_item WHERE classnum = ? $sql";
my $sth = dbh->prepare($statement) or die dbh->errstr. " preparing $statement";
$sth->execute($self->classnum) or die $sth->errstr. " executing $statement";
$sth->fetchrow_arrayref->[0];
}
=item num_used
Returns the number of used (allocated) inventory items of this class (see
L<FS::inventory_class>).
=cut
sub num_used {
shift->num_sql("svcnum IS NOT NULL AND svcnum > 0 ");
}
=item num_total
Returns the total number of inventory items of this class (see
L<FS::inventory_class>).
=cut
sub num_total {
shift->num_sql('');
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::inventory_item>, L<FS::Record>, schema.html from the base documentation.
=cut
1;
|
