SL/DB/DeliveryOrder.pm

   1 package SL::DB::DeliveryOrder;
   2
   3 use strict;
   4
   5 use Carp;
   6
   7 use Rose::DB::Object::Helpers ();
   8
   9 use SL::DB::MetaSetup::DeliveryOrder;
  10 use SL::DB::Manager::DeliveryOrder;
  11 use SL::DB::Helper::FlattenToForm;
  12 use SL::DB::Helper::LinkedRecords;
  13 use SL::DB::Helper::TransNumberGenerator;
  14
  15 use List::Util qw(first);
  16
  17 __PACKAGE__->meta->add_relationship(orderitems => { type         => 'one to many',
  18                                                     class        => 'SL::DB::DeliveryOrderItem',
  19                                                     column_map   => { id => 'delivery_order_id' },
  20                                                     manager_args => { with_objects => [ 'part' ] }
  21                                                   },
  22                                     custom_shipto => {
  23                                       type        => 'one to one',
  24                                       class       => 'SL::DB::Shipto',
  25                                       column_map  => { id => 'trans_id' },
  26                                       query_args  => [ module => 'DO' ],
  27                                     },
  28                                    );
  29
  30 __PACKAGE__->meta->initialize;
  31
  32 __PACKAGE__->before_save('_before_save_set_donumber');
  33
  34 # hooks
  35
  36 sub _before_save_set_donumber {
  37   my ($self) = @_;
  38
  39   $self->create_trans_number if !$self->donumber;
  40
  41   return 1;
  42 }
  43
  44 # methods
  45
  46 sub items { goto &orderitems; }
  47 sub add_items { goto &add_orderitems; }
  48
  49 sub items_sorted {
  50   my ($self) = @_;
  51
  52   return [ sort {$a->id <=> $b->id } @{ $self->items } ];
  53 }
  54
  55 sub sales_order {
  56   my $self   = shift;
  57   my %params = @_;
  58
  59
  60   require SL::DB::Order;
  61   my $orders = SL::DB::Manager::Order->get_all(
  62     query => [
  63       ordnumber => $self->ordnumber,
  64       @{ $params{query} || [] },
  65     ],
  66   );
  67
  68   return first { $_->is_type('sales_order') } @{ $orders };
  69 }
  70
  71 sub type {
  72   return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
  73 }
  74
  75 sub displayable_state {
  76   my ($self) = @_;
  77
  78   return join '; ',
  79     ($self->closed    ? $::locale->text('closed')    : $::locale->text('open')),
  80     ($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
  81 }
  82
  83 sub date {
  84   goto &transdate;
  85 }
  86
  87 sub _clone_orderitem_cvar {
  88   my ($cvar) = @_;
  89
  90   my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
  91   $cloned->sub_module('delivery_order_items');
  92
  93   return $cloned;
  94 }
  95
  96 sub new_from {
  97   my ($class, $source, %params) = @_;
  98
  99   croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
 100
 101   my ($item_parent_id_column, $item_parent_column);
 102
 103   if (ref($source) eq 'SL::DB::Order') {
 104     $item_parent_id_column = 'trans_id';
 105     $item_parent_column    = 'order';
 106   }
 107
 108   my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_terms->terms_netto : 0;
 109
 110   my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber department_id employee_id globalproject_id intnotes language_id notes
 111                                                 ordnumber reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
 112                                              )),
 113                closed    => 0,
 114                is_sales  => !!$source->customer_id,
 115                delivered => 0,
 116                terms     => $terms,
 117                transdate => DateTime->today_local,
 118             );
 119
 120   # Custom shipto addresses (the ones specific to the sales/purchase
 121   # record and not to the customer/vendor) are only linked from
 122   # shipto -> delivery_orders. Meaning delivery_orders.shipto_id
 123   # will not be filled in that case. Therefore we have to return the
 124   # new shipto object as a separate object so that the caller can
 125   # save it, too.
 126   my $custom_shipto;
 127   if (!$source->shipto_id && $source->id) {
 128     my $old = $source->custom_shipto;
 129     if ($old) {
 130       $custom_shipto = SL::DB::Shipto->new(
 131         map  { +($_ => $old->$_) }
 132         grep { !m{^ (?: itime | mtime | shipto_id | trans_id ) $}x }
 133         map  { $_->name }
 134         @{ $old->meta->columns }
 135       );
 136       $custom_shipto->module('DO');
 137     }
 138
 139   } else {
 140     $args{shipto_id} = $source->shipto_id;
 141   }
 142
 143   my $delivery_order = $class->new(%args);
 144   $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
 145   my $items          = delete($params{items}) || $source->items_sorted;
 146   my %item_parents;
 147
 148   my @items = map {
 149     my $source_item      = $_;
 150     my $source_item_id   = $_->$item_parent_id_column;
 151     my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
 152
 153     $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
 154     my $item_parent                  = $item_parents{$source_item_id};
 155
 156     SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
 157                                          qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
 158                                             project_id qty reqdate sellprice serialnumber transdate unit
 159                                          )),
 160                                    custom_variables => \@custom_variables,
 161                                    ordnumber        => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
 162                                  );
 163
 164   } @{ $items };
 165
 166   @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
 167   @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
 168
 169   $delivery_order->items(\@items);
 170
 171   return ($delivery_order, $custom_shipto);
 172 }
 173
 174 1;
 175 __END__
 176
 177 =pod
 178
 179 =encoding utf8
 180
 181 =head1 NAME
 182
 183 SL::DB::DeliveryOrder - Rose model for delivery orders (table
 184 "delivery_orders")
 185
 186 =head1 FUNCTIONS
 187
 188 =over 4
 189
 190 =item C<date>
 191
 192 An alias for C<transdate> for compatibility with other sales/purchase models.
 193
 194 =item C<displayable_state>
 195
 196 Returns a human-readable description of the state regarding being
 197 closed and delivered.
 198
 199 =item C<items>
 200
 201 An alias for C<deliver_orer_items> for compatibility with other
 202 sales/purchase models.
 203
 204 =item C<items_sorted>
 205
 206 Returns the delivery order items sorted by their ID (same order they
 207 appear in the frontend delivery order masks).
 208
 209 =item C<new_from $source, %params>
 210
 211 Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
 212 information from C<$source> as possible. At the moment only instances
 213 of C<SL::DB::Order> (sales quotations, sales orders, requests for
 214 quotations and purchase orders) are supported as sources.
 215
 216 The conversion copies order items into delivery order items. Dates are copied
 217 as appropriate, e.g. the C<transdate> field will be set to the current date.
 218
 219 Returns one or two objects depending on the context. In list context
 220 the new delivery order instance and a shipto instance will be
 221 returned. In scalar instance only the delivery order instance is
 222 returned.
 223
 224 Custom shipto addresses (the ones specific to the sales/purchase
 225 record and not to the customer/vendor) are only linked from C<shipto>
 226 to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
 227 be filled in that case. That's why a separate shipto object is created
 228 and returned.
 229
 230 The objects returned are not saved.
 231
 232 C<%params> can include the following options:
 233
 234 =over 2
 235
 236 =item C<items>
 237
 238 An optional array reference of RDBO instances for the items to use. If
 239 missing then the method C<items_sorted> will be called on
 240 C<$source>. This option can be used to override the sorting, to
 241 exclude certain positions or to add additional ones.
 242
 243 =item C<skip_items_negative_qty>
 244
 245 If trueish then items with a negative quantity are skipped. Items with
 246 a quantity of 0 are not affected by this option.
 247
 248 =item C<skip_items_zero_qty>
 249
 250 If trueish then items with a quantity of 0 are skipped.
 251
 252 =item C<attributes>
 253
 254 An optional hash reference. If it exists then it is passed to C<new>
 255 allowing the caller to set certain attributes for the new delivery
 256 order.
 257
 258 =back
 259
 260 =item C<sales_order>
 261
 262 TODO: Describe sales_order
 263
 264 =item C<type>
 265
 266 Returns a stringdescribing this record's type: either
 267 C<sales_delivery_order> or C<purchase_delivery_order>.
 268
 269 =back
 270
 271 =head1 BUGS
 272
 273 Nothing here yet.
 274
 275 =head1 AUTHOR
 276
 277 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 278
 279 =cut