[freeside-commits] freeside/FS/FS Schema.pm, 1.12,
1.13 inventory_class.pm, NONE, 1.1 inventory_item.pm, NONE, 1.1
Ivan,,,
ivan at wavetail.420.am
Wed Mar 8 02:05:02 PST 2006
Update of /home/cvs/cvsroot/freeside/FS/FS
In directory wavetail:/tmp/cvs-serv10076/FS/FS
Modified Files:
Schema.pm
Added Files:
inventory_class.pm inventory_item.pm
Log Message:
Add a new table for inventory with for DIDs/serials/etc., and an additional
new table for inventory category (i.e. to distinguish DIDs, serials, MACs,
etc.)
--- NEW FILE: inventory_item.pm ---
package FS::inventory_item;
use strict;
use vars qw( @ISA );
use FS::Record qw( qsearch qsearchs );
use FS::inventory_class;
@ISA = qw(FS::Record);
=head1 NAME
FS::inventory_item - Object methods for inventory_item records
=head1 SYNOPSIS
use FS::inventory_item;
$record = new FS::inventory_item \%hash;
$record = new FS::inventory_item { 'column' => 'value' };
$error = $record->insert;
$error = $new_record->replace($old_record);
$error = $record->delete;
$error = $record->check;
=head1 DESCRIPTION
An FS::inventory_item object represents a specific piece of (real or virtual)
inventory, such as a specific DID or serial number. FS::inventory_item
inherits from FS::Record. The following fields are currently supported:
=over 4
=item itemnum - primary key
=item classnum - Inventory class (see L<FS::inventory_class>)
=item item - Item identifier (unique within its inventory class)
=item svcnum - Customer servcie (see L<FS::cust_svc>)
=back
=head1 METHODS
=over 4
=item new HASHREF
Creates a new item. To add the item 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_item'; }
=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 item. 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('itemnum')
|| $self->ut_foreign_key('classnum', 'inventory_class', 'classnum' )
|| $self->ut_text('item')
|| $self->ut_numbern('svcnum')
;
return $error if $error;
$self->SUPER::check;
}
=back
=head1 BUGS
=head1 SEE ALSO
L<FS::Record>, schema.html from the base documentation.
=cut
1;
Index: Schema.pm
===================================================================
RCS file: /home/cvs/cvsroot/freeside/FS/FS/Schema.pm,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -d -r1.12 -r1.13
--- Schema.pm 18 Feb 2006 11:14:19 -0000 1.12
+++ Schema.pm 8 Mar 2006 10:05:00 -0000 1.13
@@ -443,7 +443,7 @@
#'index' => [ ['last'], ['company'] ],
'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
[ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
- [ 'county' ], [ 'state' ], [ 'country' ]
+ [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
],
},
@@ -1352,6 +1352,10 @@
'upstream_price', 'decimal', 'NULL', '10,2', '', '',
'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
+ # how it was rated internally...
+ 'ratedetailnum', 'int', 'NULL', '', '', '',
+ 'rated_price', 'decimal', 'NULL', '10,2', '', '',
+
'distance', 'decimal', 'NULL', '', '', '',
'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
@@ -1373,7 +1377,7 @@
# a svcnum... right..?
'svcnum', 'int', 'NULL', '', '', '',
- #NULL, done, skipped, pushed_downstream (or something)
+ #NULL, done (or something)
'freesidestatus', 'varchar', 'NULL', 32, '', '',
],
@@ -1412,6 +1416,39 @@
'index' => [],
},
+ #map upstream rateid (XXX or rateplanid?) to ours...
+ 'cdr_upstream_rate' => { # XXX or 'cdr_upstream_rateplan' ??
+ 'columns' => [
+ # XXX or 'upstream_rateplanid' ??
+ 'upstream_rateid', 'int', 'NULL', '', '', '',
+ 'ratedetailnum', 'int', 'NULL', '', '', '',
+ ],
+ 'primary_key' => '', #XXX need a primary key
+ 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
+ 'index' => [],
+ },
+
+ 'inventory_item' => {
+ 'columns' => [
+ 'itemnum', 'serial', '', '', '', '',
+ 'classnum', 'int', '', '', '', '',
+ 'item', 'varchar', '', $char_d, '', '',
+ 'svcnum', 'int', 'NULL', '', '', '',
+ ],
+ 'primary_key' => 'itemnum',
+ 'unique' => [ [ 'classnum', 'item' ] ],
+ 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
+ },
+
+ 'inventory_class' => {
+ 'columns' => [
+ 'classnum', 'serial', '', '', '', '',
+ 'classname', 'varchar', $char_d, '', '', '',
+ ],
+ 'primary_key' => 'classnum',
+ 'unique' => [],
+ 'index' => [],
+ },
};
--- NEW FILE: inventory_class.pm ---
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 ) = @_;
my $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;
More information about the freeside-commits
mailing list