experimental package balances, RT#4339
[freeside.git] / FS / FS / inventory_class.pm
1 package FS::inventory_class;
2
3 use strict;
4 use vars qw( @ISA );
5 use FS::Record qw( dbh qsearch qsearchs );
6
7 @ISA = qw(FS::Record);
8
9 =head1 NAME
10
11 FS::inventory_class - Object methods for inventory_class records
12
13 =head1 SYNOPSIS
14
15   use FS::inventory_class;
16
17   $record = new FS::inventory_class \%hash;
18   $record = new FS::inventory_class { 'column' => 'value' };
19
20   $error = $record->insert;
21
22   $error = $new_record->replace($old_record);
23
24   $error = $record->delete;
25
26   $error = $record->check;
27
28 =head1 DESCRIPTION
29
30 An FS::inventory_class object represents a class of inventory, such as "DID 
31 numbers" or "physical equipment serials".  FS::inventory_class inherits from
32 FS::Record.  The following fields are currently supported:
33
34 =over 4
35
36 =item classnum - primary key
37
38 =item classname - Name of this class
39
40
41 =back
42
43 =head1 METHODS
44
45 =over 4
46
47 =item new HASHREF
48
49 Creates a new inventory class.  To add the class to the database, see
50 L<"insert">.
51
52 Note that this stores the hash reference, not a distinct copy of the hash it
53 points to.  You can ask the object for a copy with the I<hash> method.
54
55 =cut
56
57 # the new method can be inherited from FS::Record, if a table method is defined
58
59 sub table { 'inventory_class'; }
60
61 =item insert
62
63 Adds this record to the database.  If there is an error, returns the error,
64 otherwise returns false.
65
66 =cut
67
68 # the insert method can be inherited from FS::Record
69
70 =item delete
71
72 Delete this record from the database.
73
74 =cut
75
76 # the delete method can be inherited from FS::Record
77
78 =item replace OLD_RECORD
79
80 Replaces the OLD_RECORD with this one in the database.  If there is an error,
81 returns the error, otherwise returns false.
82
83 =cut
84
85 # the replace method can be inherited from FS::Record
86
87 =item check
88
89 Checks all fields to make sure this is a valid inventory class.  If there is
90 an error, returns the error, otherwise returns false.  Called by the insert
91 and replace methods.
92
93 =cut
94
95 # the check method should currently be supplied - FS::Record contains some
96 # data checking routines
97
98 sub check {
99   my $self = shift;
100
101   my $error = 
102     $self->ut_numbern('classnum')
103     || $self->ut_textn('classname')
104   ;
105   return $error if $error;
106
107   $self->SUPER::check;
108 }
109
110 =item num_avail 
111
112 Returns the number of available (unused/unallocated) inventory items of this
113 class (see L<FS::inventory_item>).
114
115 =cut
116
117 sub num_avail {
118   shift->num_sql('( svcnum IS NULL OR svcnum = 0 )');
119 }
120
121 sub num_sql {
122   my( $self, $sql ) = @_;
123   $sql = "AND $sql" if length($sql);
124   my $statement =
125     "SELECT COUNT(*) FROM inventory_item WHERE classnum = ? $sql";
126   my $sth = dbh->prepare($statement) or die dbh->errstr. " preparing $statement";
127   $sth->execute($self->classnum) or die $sth->errstr. " executing $statement";
128   $sth->fetchrow_arrayref->[0];
129 }
130
131 =item num_used
132
133 Returns the number of used (allocated) inventory items of this class (see
134 L<FS::inventory_class>).
135
136 =cut
137
138 sub num_used {
139   shift->num_sql("svcnum IS NOT NULL AND svcnum > 0 ");
140 }
141
142 =item num_total
143
144 Returns the total number of inventory items of this class (see
145 L<FS::inventory_class>).
146
147 =cut
148
149 sub num_total {
150   shift->num_sql('');
151 }
152
153 =back
154
155 =head1 BUGS
156
157 =head1 SEE ALSO
158
159 L<FS::inventory_item>, L<FS::Record>, schema.html from the base documentation.
160
161 =cut
162
163 1;
164