use strict;
+use Carp;
+
+use Rose::DB::Object::Helpers ();
+
use SL::DB::MetaSetup::DeliveryOrder;
use SL::DB::Manager::DeliveryOrder;
+use SL::DB::Helper::AttrHTML;
+use SL::DB::Helper::AttrSorted;
+use SL::DB::Helper::FlattenToForm;
use SL::DB::Helper::LinkedRecords;
use SL::DB::Helper::TransNumberGenerator;
-use SL::DB::Order;
use List::Util qw(first);
__PACKAGE__->meta->add_relationship(orderitems => { type => 'one to many',
class => 'SL::DB::DeliveryOrderItem',
- column_map => { id => 'trans_id' },
+ column_map => { id => 'delivery_order_id' },
manager_args => { with_objects => [ 'part' ] }
},
- shipto => { type => 'one to one',
- class => 'SL::DB::Shipto',
- column_map => { shipto_id => 'shipto_id' },
- },
- department => { type => 'one to one',
- class => 'SL::DB::Department',
- column_map => { department_id => 'id' },
- },
+ custom_shipto => {
+ type => 'one to one',
+ class => 'SL::DB::Shipto',
+ column_map => { id => 'trans_id' },
+ query_args => [ module => 'DO' ],
+ },
);
__PACKAGE__->meta->initialize;
+__PACKAGE__->attr_html('notes');
+__PACKAGE__->attr_sorted('items');
+
+__PACKAGE__->before_save('_before_save_set_donumber');
+
+# hooks
+
+sub _before_save_set_donumber {
+ my ($self) = @_;
+
+ $self->create_trans_number if !$self->donumber;
+
+ return 1;
+}
+
# methods
sub items { goto &orderitems; }
+sub add_items { goto &add_orderitems; }
+sub payment_terms { goto &payment; }
+sub record_number { goto &donumber; }
sub sales_order {
my $self = shift;
my %params = @_;
+
+ require SL::DB::Order;
my $orders = SL::DB::Manager::Order->get_all(
query => [
ordnumber => $self->ordnumber,
return first { $_->is_type('sales_order') } @{ $orders };
}
+sub type {
+ return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
+}
+
+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';
+}
+
+sub displayable_name {
+ join ' ', grep $_, map $_[0]->$_, qw(displayable_type record_number);
+};
+
+sub displayable_state {
+ my ($self) = @_;
+
+ return join '; ',
+ ($self->closed ? $::locale->text('closed') : $::locale->text('open')),
+ ($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
+}
+
+sub date {
+ goto &transdate;
+}
+
+sub _clone_orderitem_cvar {
+ my ($cvar) = @_;
+
+ my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
+ $cloned->sub_module('delivery_order_items');
+
+ return $cloned;
+}
+
+sub new_from {
+ my ($class, $source, %params) = @_;
+
+ croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
+
+ 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';
+ }
+
+ 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
+ ordnumber payment_id reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
+ )),
+ 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) {
+ my $old = $source->custom_shipto;
+ if ($old) {
+ $custom_shipto = SL::DB::Shipto->new(
+ map { +($_ => $old->$_) }
+ grep { !m{^ (?: itime | mtime | shipto_id | trans_id ) $}x }
+ map { $_->name }
+ @{ $old->meta->columns }
+ );
+ $custom_shipto->module('DO');
+ }
+
+ } else {
+ $args{shipto_id} = $source->shipto_id;
+ }
+
+ my $delivery_order = $class->new(%args);
+ $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
+ my $items = delete($params{items}) || $source->items_sorted;
+ my %item_parents;
+
+ my @items = map {
+ my $source_item = $_;
+ my $source_item_id = $_->$item_parent_id_column;
+ my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
+
+ $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
+ my $item_parent = $item_parents{$source_item_id};
+
+ SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
+ qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
+ project_id qty reqdate sellprice serialnumber transdate unit active_discount_source active_price_source
+ )),
+ custom_variables => \@custom_variables,
+ ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
+ );
+
+ } @{ $items };
+
+ @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
+ @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
+ @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
+
+ $delivery_order->items(\@items);
+
+ return ($delivery_order, $custom_shipto);
+}
+
+sub customervendor {
+ $_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
+}
+
+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;
+ $invoice = SL::DB::Invoice->new_from($self, %params)->post || die;
+ $self->link_to_record($invoice);
+ foreach my $item (@{ $invoice->items }) {
+ foreach (qw(delivery_order_items)) { # expand if needed (delivery_order_items)
+ 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;
+}
+
1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::DB::DeliveryOrder - Rose model for delivery orders (table
+"delivery_orders")
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<date>
+
+An alias for C<transdate> for compatibility with other sales/purchase models.
+
+=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".
+
+=item C<displayable_state>
+
+Returns a human-readable description of the state regarding being
+closed and delivered.
+
+=item C<items>
+
+An alias for C<delivery_order_items> for compatibility with other
+sales/purchase models.
+
+=item C<new_from $source, %params>
+
+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.
+
+C<%params> can include the following options:
+
+=over 2
+
+=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.
+
+=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.
+
+=item C<skip_items_zero_qty>
+
+If trueish then items with a quantity of 0 are skipped.
+
+=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.
+
+=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
+
+=item C<sales_order>
+
+TODO: Describe sales_order
+
+=item C<type>
+
+Returns a string describing this record's type: either
+C<sales_delivery_order> or C<purchase_delivery_order>.
+
+=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.
+
+The arguments in C<%params> are passed to L<SL::DB::Invoice::new_from>.
+
+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.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut
projects / kivitendo-erp.git / blobdiff