kivitendo/SL/DB/DeliveryOrder.pm @ 3f0ed511
| 82515b2d | Sven Schöling | package SL::DB::DeliveryOrder;
|
||
use strict;
|
||||
| a93f1e39 | Moritz Bunkus | use Carp;
|
||
| 2714604a | Moritz Bunkus | use Rose::DB::Object::Helpers ();
|
||
| 82515b2d | Sven Schöling | use SL::DB::MetaSetup::DeliveryOrder;
|
||
use SL::DB::Manager::DeliveryOrder;
|
||||
| a34c05f3 | Moritz Bunkus | use SL::DB::Helper::AttrHTML;
|
||
| f63af42d | Moritz Bunkus | use SL::DB::Helper::AttrSorted;
|
||
| a60c6759 | Moritz Bunkus | use SL::DB::Helper::FlattenToForm;
|
||
| b9dbc9e3 | Moritz Bunkus | use SL::DB::Helper::LinkedRecords;
|
||
use SL::DB::Helper::TransNumberGenerator;
|
||||
| 82515b2d | Sven Schöling | |||
use List::Util qw(first);
|
||||
__PACKAGE__->meta->add_relationship(orderitems => { type => 'one to many',
|
||||
class => 'SL::DB::DeliveryOrderItem',
|
||||
| 20f266d2 | Bernd Bleßmann | column_map => { id => 'delivery_order_id' },
|
||
| 0845c4b7 | Moritz Bunkus | manager_args => { with_objects => [ 'part' ] }
|
||
| 82515b2d | Sven Schöling | },
|
||
| 325c539c | Moritz Bunkus | custom_shipto => {
|
||
type => 'one to one',
|
||||
class => 'SL::DB::Shipto',
|
||||
column_map => { id => 'trans_id' },
|
||||
query_args => [ module => 'DO' ],
|
||||
},
|
||||
| 82515b2d | Sven Schöling | );
|
||
__PACKAGE__->meta->initialize;
|
||||
| a34c05f3 | Moritz Bunkus | __PACKAGE__->attr_html('notes');
|
||
| f63af42d | Moritz Bunkus | __PACKAGE__->attr_sorted('items');
|
||
| a34c05f3 | Moritz Bunkus | |||
| 08d2e0ca | Moritz Bunkus | __PACKAGE__->before_save('_before_save_set_donumber');
|
||
# hooks
|
||||
sub _before_save_set_donumber {
|
||||
my ($self) = @_;
|
||||
$self->create_trans_number if !$self->donumber;
|
||||
return 1;
|
||||
}
|
||||
| 82515b2d | Sven Schöling | # methods
|
||
| 4ac74078 | Moritz Bunkus | sub items { goto &orderitems; }
|
||
| ae906113 | Moritz Bunkus | sub add_items { goto &add_orderitems; }
|
||
| 464f44ac | Moritz Bunkus | sub payment_terms { goto &payment; }
|
||
| 4f7e0fa9 | Geoffrey Richardson | sub record_number { goto &donumber; }
|
||
| 4ac74078 | Moritz Bunkus | |||
| 82515b2d | Sven Schöling | sub sales_order {
|
||
my $self = shift;
|
||||
my %params = @_;
|
||||
| f7e89226 | Sven Schöling | |||
require SL::DB::Order;
|
||||
| 82515b2d | Sven Schöling | my $orders = SL::DB::Manager::Order->get_all(
|
||
query => [
|
||||
ordnumber => $self->ordnumber,
|
||||
@{ $params{query} || [] },
|
||||
],
|
||||
);
|
||||
return first { $_->is_type('sales_order') } @{ $orders };
|
||||
}
|
||||
| 2746ccd0 | Sven Schöling | sub type {
|
||
return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
|
||||
}
|
||||
| b3dcf24a | Geoffrey Richardson | sub displayable_type {
|
||
my $type = shift->type;
|
||||
return $::locale->text('Sales Delivery Order') if $type eq 'sales_delivery_order';
|
||||
return $::locale->text('Purchase Delivery Order') if $type eq 'purchase_delivery_order';
|
||||
die 'invalid type';
|
||||
}
|
||||
| a7114646 | Geoffrey Richardson | sub displayable_name {
|
||
join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
|
||||
};
|
||||
| b3dcf24a | Geoffrey Richardson | |||
| 2746ccd0 | Sven Schöling | sub displayable_state {
|
||
my ($self) = @_;
|
||||
return join '; ',
|
||||
($self->closed ? $::locale->text('closed') : $::locale->text('open')),
|
||||
($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
|
||||
}
|
||||
| 16c6be41 | Moritz Bunkus | sub date {
|
||
goto &transdate;
|
||||
}
|
||||
| 2714604a | Moritz Bunkus | sub _clone_orderitem_cvar {
|
||
my ($cvar) = @_;
|
||||
my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
|
||||
$cloned->sub_module('delivery_order_items');
|
||||
return $cloned;
|
||||
}
|
||||
| 7664f50f | Moritz Bunkus | sub new_from {
|
||
my ($class, $source, %params) = @_;
|
||||
croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
|
||||
| f4de41a2 | Moritz Bunkus | my ($item_parent_id_column, $item_parent_column);
|
||
if (ref($source) eq 'SL::DB::Order') {
|
||||
$item_parent_id_column = 'trans_id';
|
||||
$item_parent_column = 'order';
|
||||
}
|
||||
| 3572290b | Bernd Bleßmann | my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber delivery_term_id department_id employee_id globalproject_id intnotes language_id notes
|
||
| 464f44ac | Moritz Bunkus | ordnumber payment_id reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
|
||
| 7664f50f | Moritz Bunkus | )),
|
||
closed => 0,
|
||||
is_sales => !!$source->customer_id,
|
||||
delivered => 0,
|
||||
transdate => DateTime->today_local,
|
||||
);
|
||||
# Custom shipto addresses (the ones specific to the sales/purchase
|
||||
# record and not to the customer/vendor) are only linked from
|
||||
# shipto -> delivery_orders. Meaning delivery_orders.shipto_id
|
||||
# will not be filled in that case. Therefore we have to return the
|
||||
# new shipto object as a separate object so that the caller can
|
||||
# save it, too.
|
||||
my $custom_shipto;
|
||||
if (!$source->shipto_id && $source->id) {
|
||||
| 3f0ed511 | Moritz Bunkus | $custom_shipto = $source->custom_shipto->clone($class) if $source->can('custom_shipto') && $source->custom_shipto;
|
||
| 7664f50f | Moritz Bunkus | |||
} else {
|
||||
$args{shipto_id} = $source->shipto_id;
|
||||
}
|
||||
| 6473dcb1 | Moritz Bunkus | my $delivery_order = $class->new(%args);
|
||
$delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
|
||||
| 53aad992 | Moritz Bunkus | my $items = delete($params{items}) || $source->items_sorted;
|
||
| f4de41a2 | Moritz Bunkus | my %item_parents;
|
||
| 7664f50f | Moritz Bunkus | |||
my @items = map {
|
||||
| 2714604a | Moritz Bunkus | my $source_item = $_;
|
||
| f4de41a2 | Moritz Bunkus | my $source_item_id = $_->$item_parent_id_column;
|
||
| 2714604a | Moritz Bunkus | my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
|
||
| f4de41a2 | Moritz Bunkus | $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
|
||
my $item_parent = $item_parents{$source_item_id};
|
||||
| fc890e10 | Jan Büren | my $current_do_item = SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
|
||
| f4de41a2 | Moritz Bunkus | qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
|
||
| a94080db | Moritz Bunkus | project_id qty reqdate sellprice serialnumber transdate unit active_discount_source active_price_source
|
||
| 2714604a | Moritz Bunkus | )),
|
||
| f4de41a2 | Moritz Bunkus | custom_variables => \@custom_variables,
|
||
ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
|
||||
);
|
||||
| fc890e10 | Jan Büren | $current_do_item->{"converted_from_orderitems_id"} = $_->{id} if ref($item_parent) eq 'SL::DB::Order';
|
||
$current_do_item;
|
||||
| 53aad992 | Moritz Bunkus | } @{ $items };
|
||
| 7664f50f | Moritz Bunkus | |||
| bbb98e03 | Moritz Bunkus | @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
|
||
| c37da034 | Moritz Bunkus | @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
|
||
| f9fdf190 | Moritz Bunkus | @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
|
||
| c37da034 | Moritz Bunkus | |||
| 7664f50f | Moritz Bunkus | $delivery_order->items(\@items);
|
||
return ($delivery_order, $custom_shipto);
|
||||
}
|
||||
| 44310118 | Jan Büren | sub customervendor {
|
||
$_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
|
||||
}
|
||||
| a7ca8ba2 | Jan Büren | sub convert_to_invoice {
|
||
my ($self, %params) = @_;
|
||||
croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
|
||||
my $invoice;
|
||||
if (!$self->db->with_transaction(sub {
|
||||
require SL::DB::Invoice;
|
||||
| 38666007 | Jan Büren | $invoice = SL::DB::Invoice->new_from($self, %params)->post || die;
|
||
| a7ca8ba2 | Jan Büren | $self->link_to_record($invoice);
|
||
| fc890e10 | Jan Büren | # TODO extend link_to_record for items, otherwise long-term no d.r.y.
|
||
| a7ca8ba2 | Jan Büren | foreach my $item (@{ $invoice->items }) {
|
||
| fc890e10 | Jan Büren | foreach (qw(delivery_order_items)) { # expand if needed (orderitems)
|
||
| a7ca8ba2 | Jan Büren | if ($item->{"converted_from_${_}_id"}) {
|
||
die unless $item->{id};
|
||||
RecordLinks->create_links('mode' => 'ids',
|
||||
'from_table' => $_,
|
||||
'from_ids' => $item->{"converted_from_${_}_id"},
|
||||
'to_table' => 'invoice',
|
||||
'to_id' => $item->{id},
|
||||
) || die;
|
||||
delete $item->{"converted_from_${_}_id"};
|
||||
}
|
||||
}
|
||||
}
|
||||
$self->update_attributes(closed => 1);
|
||||
1;
|
||||
})) {
|
||||
return undef;
|
||||
}
|
||||
return $invoice;
|
||||
}
|
||||
| 82515b2d | Sven Schöling | 1;
|
||
| 7664f50f | Moritz Bunkus | __END__
|
||
=pod
|
||||
=encoding utf8
|
||||
=head1 NAME
|
||||
SL::DB::DeliveryOrder - Rose model for delivery orders (table
|
||||
"delivery_orders")
|
||||
=head1 FUNCTIONS
|
||||
=over 4
|
||||
=item C<date>
|
||||
| 46f7dbff | Moritz Bunkus | An alias for C<transdate> for compatibility with other sales/purchase models.
|
||
| 7664f50f | Moritz Bunkus | |||
| 51264c43 | Geoffrey Richardson | =item C<displayable_name>
|
||
Returns a human-readable and translated description of the delivery order, consisting of
|
||||
record type and number, e.g. "Verkaufslieferschein 123".
|
||||
| 7664f50f | Moritz Bunkus | =item C<displayable_state>
|
||
Returns a human-readable description of the state regarding being
|
||||
closed and delivered.
|
||||
=item C<items>
|
||||
| 51264c43 | Geoffrey Richardson | An alias for C<delivery_order_items> for compatibility with other
|
||
| 7664f50f | Moritz Bunkus | sales/purchase models.
|
||
| c37da034 | Moritz Bunkus | =item C<new_from $source, %params>
|
||
| 7664f50f | Moritz Bunkus | |||
Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
|
||||
information from C<$source> as possible. At the moment only instances
|
||||
of C<SL::DB::Order> (sales quotations, sales orders, requests for
|
||||
quotations and purchase orders) are supported as sources.
|
||||
The conversion copies order items into delivery order items. Dates are copied
|
||||
as appropriate, e.g. the C<transdate> field will be set to the current date.
|
||||
Returns one or two objects depending on the context. In list context
|
||||
the new delivery order instance 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.
|
||||
The objects returned are not saved.
|
||||
| c37da034 | Moritz Bunkus | C<%params> can include the following options:
|
||
=over 2
|
||||
| 53aad992 | Moritz Bunkus | =item C<items>
|
||
An optional array reference of RDBO instances for the items to use. If
|
||||
missing then the method C<items_sorted> will be called on
|
||||
C<$source>. This option can be used to override the sorting, to
|
||||
exclude certain positions or to add additional ones.
|
||||
| f9fdf190 | Moritz Bunkus | =item C<skip_items_negative_qty>
|
||
If trueish then items with a negative quantity are skipped. Items with
|
||||
a quantity of 0 are not affected by this option.
|
||||
| c37da034 | Moritz Bunkus | =item C<skip_items_zero_qty>
|
||
If trueish then items with a quantity of 0 are skipped.
|
||||
| bbb98e03 | Moritz Bunkus | =item C<item_filter>
|
||
An optional code reference that is called for each item with the item
|
||||
as its sole parameter. Items for which the code reference returns a
|
||||
falsish value will be skipped.
|
||||
| c37da034 | Moritz Bunkus | =item C<attributes>
|
||
An optional hash reference. If it exists then it is passed to C<new>
|
||||
allowing the caller to set certain attributes for the new delivery
|
||||
order.
|
||||
=back
|
||||
| 7664f50f | Moritz Bunkus | =item C<sales_order>
|
||
TODO: Describe sales_order
|
||||
=item C<type>
|
||||
| 51264c43 | Geoffrey Richardson | Returns a string describing this record's type: either
|
||
| 7664f50f | Moritz Bunkus | C<sales_delivery_order> or C<purchase_delivery_order>.
|
||
| a7ca8ba2 | Jan Büren | =item C<convert_to_invoice %params>
|
||
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.
|
||||
| 38666007 | Jan Büren | The arguments in C<%params> are passed to L<SL::DB::Invoice::new_from>.
|
||
| a7ca8ba2 | Jan Büren | |||
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.
|
||||
At the moment only sales delivery orders can be converted.
|
||||
| 7664f50f | Moritz Bunkus | =back
|
||
=head1 BUGS
|
||||
Nothing here yet.
|
||||
=head1 AUTHOR
|
||||
Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
|
||||
=cut
|