diff options
author | Ivan Kohler <ivan@freeside.biz> | 2013-06-08 01:30:52 -0700 |
---|---|---|
committer | Ivan Kohler <ivan@freeside.biz> | 2013-06-08 01:30:52 -0700 |
commit | e96a2a6fd3a8885b0fb035ecc55bdf50dbe5a4aa (patch) | |
tree | 1be65eac435d9445d71a2c63e33fefe94db96349 /FS/FS/part_pkg_currency.pm | |
parent | 0f21021fea8f99d28b4507c3cffa55cbdd6f110d (diff) |
multi-currency, RT#21565
Diffstat (limited to 'FS/FS/part_pkg_currency.pm')
-rw-r--r-- | FS/FS/part_pkg_currency.pm | 139 |
1 files changed, 139 insertions, 0 deletions
diff --git a/FS/FS/part_pkg_currency.pm b/FS/FS/part_pkg_currency.pm new file mode 100644 index 0000000..246abee --- /dev/null +++ b/FS/FS/part_pkg_currency.pm @@ -0,0 +1,139 @@ +package FS::part_pkg_currency; +use base qw( FS::Record ); + +use strict; +#use FS::Record qw( qsearch qsearchs ); +use FS::part_pkg; + +=head1 NAME + +FS::part_pkg_currency - Object methods for part_pkg_currency records + +=head1 SYNOPSIS + + use FS::part_pkg_currency; + + $record = new FS::part_pkg_currency \%hash; + $record = new FS::part_pkg_currency { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +=head1 DESCRIPTION + +An FS::part_pkg_currency object represents an example. FS::part_pkg_currency inherits from +FS::Record. The following fields are currently supported: + +=over 4 + +=item pkgcurrencynum + +primary key + +=item pkgpart + +Package definition (see L<FS::part_pkg>). + +=item currency + +3-letter currency code + +=item optionname + +optionname + +=item optionvalue + +optionvalue + + +=back + +=head1 METHODS + +=over 4 + +=item new HASHREF + +Creates a new example. To add the example 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 { 'part_pkg_currency'; } + +=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 example. 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('pkgcurrencynum') + || $self->ut_foreign_key('pkgpart', 'part_pkg', 'pkgpart') + || $self->ut_currency('currency') + || $self->ut_text('optionname') + || $self->ut_textn('optionvalue') + ; + return $error if $error; + + $self->SUPER::check; +} + +=back + +=head1 BUGS + +The author forgot to customize this manpage. + +=head1 SEE ALSO + +L<FS::Record>, schema.html from the base documentation. + +=cut + +1; + |