kivitendo/SL/DB/Order.pm @ 7c54e92f
| 82515b2d | Sven Schöling | package SL::DB::Order;
|
||
| 05c6840d | Moritz Bunkus | use utf8;
|
||
| 82515b2d | Sven Schöling | use strict;
|
||
| 42ea98b4 | Moritz Bunkus | use Carp;
|
||
use DateTime;
|
||||
use List::Util qw(max);
|
||||
| 82515b2d | Sven Schöling | |||
use SL::DB::MetaSetup::Order;
|
||||
use SL::DB::Manager::Order;
|
||||
| c692dae1 | Moritz Bunkus | use SL::DB::Helper::FlattenToForm;
|
||
| e9fb6244 | Moritz Bunkus | use SL::DB::Helper::LinkedRecords;
|
||
use SL::DB::Helper::PriceTaxCalculator;
|
||||
| 2209370e | Moritz Bunkus | use SL::DB::Helper::PriceUpdater;
|
||
| b9dbc9e3 | Moritz Bunkus | use SL::DB::Helper::TransNumberGenerator;
|
||
| 42ea98b4 | Moritz Bunkus | use SL::RecordLinks;
|
||
| 0409db7c | Sven Schöling | use Rose::DB::Object::Helpers qw(as_tree);
|
||
| 82515b2d | Sven Schöling | |||
__PACKAGE__->meta->add_relationship(
|
||||
orderitems => {
|
||||
type => 'one to many',
|
||||
class => 'SL::DB::OrderItem',
|
||||
column_map => { id => 'trans_id' },
|
||||
manager_args => {
|
||||
| 0845c4b7 | Moritz Bunkus | with_objects => [ 'part' ]
|
||
| 82515b2d | Sven Schöling | }
|
||
| 250fa402 | Moritz Bunkus | },
|
||
periodic_invoices_config => {
|
||||
| 27bb493f | Moritz Bunkus | type => 'one to one',
|
||
| 250fa402 | Moritz Bunkus | class => 'SL::DB::PeriodicInvoicesConfig',
|
||
column_map => { id => 'oe_id' },
|
||||
},
|
||||
| 325c539c | Moritz Bunkus | custom_shipto => {
|
||
type => 'one to one',
|
||||
class => 'SL::DB::Shipto',
|
||||
column_map => { id => 'trans_id' },
|
||||
query_args => [ module => 'OE' ],
|
||||
},
|
||||
| 82515b2d | Sven Schöling | );
|
||
__PACKAGE__->meta->initialize;
|
||||
| 1bcb4ec6 | Moritz Bunkus | __PACKAGE__->before_save('_before_save_set_ord_quo_number');
|
||
# hooks
|
||||
sub _before_save_set_ord_quo_number {
|
||||
my ($self) = @_;
|
||||
# ordnumber is 'NOT NULL'. Therefore make sure it's always set to at
|
||||
# least an empty string, even if we're saving a quotation.
|
||||
$self->ordnumber('') if !$self->ordnumber;
|
||||
my $field = $self->quotation ? 'quonumber' : 'ordnumber';
|
||||
$self->create_trans_number if !$self->$field;
|
||||
return 1;
|
||||
}
|
||||
| 82515b2d | Sven Schöling | # methods
|
||
| 0845c4b7 | Moritz Bunkus | sub items { goto &orderitems; }
|
||
| ae906113 | Moritz Bunkus | sub add_items { goto &add_orderitems; }
|
||
| 4ac74078 | Moritz Bunkus | |||
| 56b91fb4 | Bernd Bleßmann | sub items_sorted {
|
||
my ($self) = @_;
|
||||
| 42e01a1a | Bernd Bleßmann | return [ sort {$a->position <=> $b->position } @{ $self->items } ];
|
||
| 56b91fb4 | Bernd Bleßmann | }
|
||
| 82515b2d | Sven Schöling | sub type {
|
||
my $self = shift;
|
||||
return 'sales_order' if $self->customer_id && ! $self->quotation;
|
||||
return 'purchase_order' if $self->vendor_id && ! $self->quotation;
|
||||
return 'sales_quotation' if $self->customer_id && $self->quotation;
|
||||
return 'request_quotation' if $self->vendor_id && $self->quotation;
|
||||
return;
|
||||
}
|
||||
sub is_type {
|
||||
return shift->type eq shift;
|
||||
}
|
||||
| 2746ccd0 | Sven Schöling | sub displayable_type {
|
||
my $type = shift->type;
|
||||
return $::locale->text('Sales quotation') if $type eq 'sales_quotation';
|
||||
return $::locale->text('Request quotation') if $type eq 'request_quotation';
|
||||
return $::locale->text('Sales Order') if $type eq 'sales_order';
|
||||
return $::locale->text('Purchase Order') if $type eq 'purchase_order';
|
||||
die 'invalid type';
|
||||
}
|
||||
| 211de9e3 | Sven Schöling | sub is_sales {
|
||
croak 'not an accessor' if @_ > 1;
|
||||
| 61bd6288 | Moritz Bunkus | return !!shift->customer_id;
|
||
| 211de9e3 | Sven Schöling | }
|
||
| 82515b2d | Sven Schöling | sub invoices {
|
||
my $self = shift;
|
||||
my %params = @_;
|
||||
if ($self->quotation) {
|
||||
return [];
|
||||
} else {
|
||||
| 71e6f43b | Sven Schöling | require SL::DB::Invoice;
|
||
| 82515b2d | Sven Schöling | return SL::DB::Manager::Invoice->get_all(
|
||
query => [
|
||||
ordnumber => $self->ordnumber,
|
||||
@{ $params{query} || [] },
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
||||
| 2746ccd0 | Sven Schöling | sub displayable_state {
|
||
my ($self) = @_;
|
||||
return $self->closed ? $::locale->text('closed') : $::locale->text('open');
|
||||
}
|
||||
| 82515b2d | Sven Schöling | sub abschlag_invoices {
|
||
return shift()->invoices(query => [ abschlag => 1 ]);
|
||||
}
|
||||
sub end_invoice {
|
||||
return shift()->invoices(query => [ abschlag => 0 ]);
|
||||
}
|
||||
| 42ea98b4 | Moritz Bunkus | sub convert_to_invoice {
|
||
my ($self, %params) = @_;
|
||||
| f4dca613 | Moritz Bunkus | croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
|
||
| 42ea98b4 | Moritz Bunkus | my $invoice;
|
||
| 0fdcea4d | Moritz Bunkus | if (!$self->db->with_transaction(sub {
|
||
| c50f0950 | Moritz Bunkus | require SL::DB::Invoice;
|
||
| 42ea98b4 | Moritz Bunkus | $invoice = SL::DB::Invoice->new_from($self)->post(%params) || die;
|
||
$self->link_to_record($invoice);
|
||||
$self->update_attributes(closed => 1);
|
||||
| 0fdcea4d | Moritz Bunkus | 1;
|
||
| 42ea98b4 | Moritz Bunkus | })) {
|
||
return undef;
|
||||
}
|
||||
return $invoice;
|
||||
}
|
||||
| 7664f50f | Moritz Bunkus | sub convert_to_delivery_order {
|
||
| c37da034 | Moritz Bunkus | my ($self, @args) = @_;
|
||
| 7664f50f | Moritz Bunkus | |||
my ($delivery_order, $custom_shipto);
|
||||
| 0fdcea4d | Moritz Bunkus | if (!$self->db->with_transaction(sub {
|
||
| 7664f50f | Moritz Bunkus | require SL::DB::DeliveryOrder;
|
||
| c37da034 | Moritz Bunkus | ($delivery_order, $custom_shipto) = SL::DB::DeliveryOrder->new_from($self, @args);
|
||
| 7664f50f | Moritz Bunkus | $delivery_order->save;
|
||
$custom_shipto->save if $custom_shipto;
|
||||
$self->link_to_record($delivery_order);
|
||||
| 1c9c1ad9 | Moritz Bunkus | $self->update_attributes(delivered => 1);
|
||
| 0fdcea4d | Moritz Bunkus | 1;
|
||
| 7664f50f | Moritz Bunkus | })) {
|
||
| 0fdcea4d | Moritz Bunkus | return wantarray ? () : undef;
|
||
| 7664f50f | Moritz Bunkus | }
|
||
return wantarray ? ($delivery_order, $custom_shipto) : $delivery_order;
|
||||
}
|
||||
| 3a4ddae0 | Sven Schöling | sub number {
|
||
my $self = shift;
|
||||
my %number_method = (
|
||||
sales_order => 'ordnumber',
|
||||
sales_quotation => 'quonumber',
|
||||
| 71180454 | Sven Schöling | purchase_order => 'ordnumber',
|
||
| 3a4ddae0 | Sven Schöling | request_quotation => 'quonumber',
|
||
);
|
||||
return $self->${ \ $number_method{$self->type} }(@_);
|
||||
}
|
||||
| 9589ecd7 | Sven Schöling | sub customervendor {
|
||
$_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
|
||||
}
|
||||
| 16c6be41 | Moritz Bunkus | sub date {
|
||
goto &transdate;
|
||||
}
|
||||
| 82515b2d | Sven Schöling | 1;
|
||
__END__
|
||||
=head1 NAME
|
||||
SL::DB::Order - Order Datenbank Objekt.
|
||||
=head1 FUNCTIONS
|
||||
| d80ffb81 | Sven Schöling | =head2 C<type>
|
||
| 82515b2d | Sven Schöling | |||
Returns one of the following string types:
|
||||
=over 4
|
||||
| d80ffb81 | Sven Schöling | =item sales_order
|
||
| 82515b2d | Sven Schöling | |||
=item purchase_order
|
||||
=item sales_quotation
|
||||
=item request_quotation
|
||||
=back
|
||||
| d80ffb81 | Sven Schöling | =head2 C<is_type TYPE>
|
||
| 82515b2d | Sven Schöling | |||
| d80ffb81 | Sven Schöling | Returns true if the order is of the given type.
|
||
| 82515b2d | Sven Schöling | |||
| 7664f50f | Moritz Bunkus | =head2 C<convert_to_delivery_order %params>
|
||
Creates a new delivery order with C<$self> as the basis by calling
|
||||
L<SL::DB::DeliveryOrder::new_from>. That delivery order is saved, and
|
||||
| 1c9c1ad9 | Moritz Bunkus | C<$self> is linked to the new invoice via
|
||
L<SL::DB::RecordLink>. C<$self>'s C<delivered> attribute is set to
|
||||
C<true>, and C<$self> is saved.
|
||||
| 7664f50f | Moritz Bunkus | |||
The arguments in C<%params> are passed to
|
||||
L<SL::DB::DeliveryOrder::new_from>.
|
||||
Returns C<undef> on failure. Otherwise the return value depends on the
|
||||
context. In list context the new delivery order and a shipto instance
|
||||
will be returned. In scalar instance only the delivery order instance
|
||||
is returned.
|
||||
Custom shipto addresses (the ones specific to the sales/purchase
|
||||
record and not to the customer/vendor) are only linked from C<shipto>
|
||||
to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
|
||||
be filled in that case. That's why a separate shipto object is created
|
||||
and returned.
|
||||
| d80ffb81 | Sven Schöling | =head2 C<convert_to_invoice %params>
|
||
| 62bb3c51 | Moritz Bunkus | |||
Creates a new invoice with C<$self> as the basis by calling
|
||||
L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
|
||||
linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
|
||||
C<closed> attribute is set to C<true>, and C<$self> is saved.
|
||||
| ed3be965 | Moritz Bunkus | The arguments in C<%params> are passed to L<SL::DB::Invoice::post>.
|
||
| 62bb3c51 | Moritz Bunkus | |||
| 78600d89 | Moritz Bunkus | Returns the new invoice instance on success and C<undef> on
|
||
failure. The whole process is run inside a transaction. On failure
|
||||
nothing is created or changed in the database.
|
||||
| 62bb3c51 | Moritz Bunkus | |||
At the moment only sales quotations and sales orders can be converted.
|
||||
| d80ffb81 | Sven Schöling | =head2 C<create_sales_process>
|
||
| 78600d89 | Moritz Bunkus | |||
Creates and saves a new sales process. Can only be called for sales
|
||||
orders.
|
||||
The newly created process will be linked bidirectionally to both
|
||||
C<$self> and to all sales quotations that are linked to C<$self>.
|
||||
Returns the newly created process instance.
|
||||
| 82515b2d | Sven Schöling | =head1 BUGS
|
||
Nothing here yet.
|
||||
=head1 AUTHOR
|
||||
| 05c6840d | Moritz Bunkus | Sven Schöling <s.schoeling@linet-services.de>
|
||
| 82515b2d | Sven Schöling | |||
=cut
|