1 package FS::inventory_class;
5 use FS::Record qw( dbh qsearch qsearchs );
11 FS::inventory_class - Object methods for inventory_class records
15 use FS::inventory_class;
17 $record = new FS::inventory_class \%hash;
18 $record = new FS::inventory_class { 'column' => 'value' };
20 $error = $record->insert;
22 $error = $new_record->replace($old_record);
24 $error = $record->delete;
26 $error = $record->check;
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:
36 =item classnum - primary key
38 =item classname - Name of this class
49 Creates a new inventory class. To add the class to the database, see
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.
57 # the new method can be inherited from FS::Record, if a table method is defined
59 sub table { 'inventory_class'; }
63 Adds this record to the database. If there is an error, returns the error,
64 otherwise returns false.
68 # the insert method can be inherited from FS::Record
72 Delete this record from the database.
76 # the delete method can be inherited from FS::Record
78 =item replace OLD_RECORD
80 Replaces the OLD_RECORD with this one in the database. If there is an error,
81 returns the error, otherwise returns false.
85 # the replace method can be inherited from FS::Record
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
95 # the check method should currently be supplied - FS::Record contains some
96 # data checking routines
102 $self->ut_numbern('classnum')
103 || $self->ut_textn('classname')
105 return $error if $error;
112 Returns the number of available (unused/unallocated) inventory items of this
113 class (see L<FS::inventory_item>).
118 shift->num_sql('( svcnum IS NULL OR svcnum = 0 )');
122 my( $self, $sql ) = @_;
123 $sql = "AND $sql" if length($sql);
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];
133 Returns the number of used (allocated) inventory items of this class (see
134 L<FS::inventory_class>).
139 shift->num_sql("svcnum IS NOT NULL AND svcnum > 0 ");
144 Returns the total number of inventory items of this class (see
145 L<FS::inventory_class>).
159 L<FS::inventory_item>, L<FS::Record>, schema.html from the base documentation.