SL/DB/Order.pm

   1 package SL::DB::Order;
   2
   3 use utf8;
   4 use strict;
   5
   6 use Carp;
   7 use DateTime;
   8 use List::Util qw(max);
   9
  10 use SL::DB::MetaSetup::Order;
  11 use SL::DB::Manager::Order;
  12 use SL::DB::Helper::FlattenToForm;
  13 use SL::DB::Helper::LinkedRecords;
  14 use SL::DB::Helper::PriceTaxCalculator;
  15 use SL::DB::Helper::PriceUpdater;
  16 use SL::DB::Helper::TransNumberGenerator;
  17 use SL::RecordLinks;
  18
  19 __PACKAGE__->meta->add_relationship(
  20   orderitems => {
  21     type         => 'one to many',
  22     class        => 'SL::DB::OrderItem',
  23     column_map   => { id => 'trans_id' },
  24     manager_args => {
  25       with_objects => [ 'part' ]
  26     }
  27   },
  28   periodic_invoices_config => {
  29     type                   => 'one to one',
  30     class                  => 'SL::DB::PeriodicInvoicesConfig',
  31     column_map             => { id => 'oe_id' },
  32   },
  33 );
  34
  35 __PACKAGE__->meta->initialize;
  36
  37 __PACKAGE__->before_save('_before_save_set_ord_quo_number');
  38
  39 # hooks
  40
  41 sub _before_save_set_ord_quo_number {
  42   my ($self) = @_;
  43
  44   # ordnumber is 'NOT NULL'. Therefore make sure it's always set to at
  45   # least an empty string, even if we're saving a quotation.
  46   $self->ordnumber('') if !$self->ordnumber;
  47
  48   my $field = $self->quotation ? 'quonumber' : 'ordnumber';
  49   $self->create_trans_number if !$self->$field;
  50
  51   return 1;
  52 }
  53
  54 # methods
  55
  56 sub items { goto &orderitems; }
  57
  58 sub items_sorted {
  59   my ($self) = @_;
  60
  61   return [ sort {$a->id <=> $b->id } @{ $self->items } ];
  62 }
  63
  64 sub type {
  65   my $self = shift;
  66
  67   return 'sales_order'       if $self->customer_id && ! $self->quotation;
  68   return 'purchase_order'    if $self->vendor_id   && ! $self->quotation;
  69   return 'sales_quotation'   if $self->customer_id &&   $self->quotation;
  70   return 'request_quotation' if $self->vendor_id   &&   $self->quotation;
  71
  72   return;
  73 }
  74
  75 sub is_type {
  76   return shift->type eq shift;
  77 }
  78
  79 sub displayable_type {
  80   my $type = shift->type;
  81
  82   return $::locale->text('Sales quotation')   if $type eq 'sales_quotation';
  83   return $::locale->text('Request quotation') if $type eq 'request_quotation';
  84   return $::locale->text('Sales Order')       if $type eq 'sales_order';
  85   return $::locale->text('Purchase Order')    if $type eq 'purchase_order';
  86
  87   die 'invalid type';
  88 }
  89
  90
  91 sub is_sales {
  92   croak 'not an accessor' if @_ > 1;
  93   return !!shift->customer_id;
  94 }
  95
  96 sub invoices {
  97   my $self   = shift;
  98   my %params = @_;
  99
 100   if ($self->quotation) {
 101     return [];
 102   } else {
 103     require SL::DB::Invoice;
 104     return SL::DB::Manager::Invoice->get_all(
 105       query => [
 106         ordnumber => $self->ordnumber,
 107         @{ $params{query} || [] },
 108       ]
 109     );
 110   }
 111 }
 112
 113 sub displayable_state {
 114   my ($self) = @_;
 115
 116   return $self->closed ? $::locale->text('closed') : $::locale->text('open');
 117 }
 118
 119 sub abschlag_invoices {
 120   return shift()->invoices(query => [ abschlag => 1 ]);
 121 }
 122
 123 sub end_invoice {
 124   return shift()->invoices(query => [ abschlag => 0 ]);
 125 }
 126
 127 sub convert_to_invoice {
 128   my ($self, %params) = @_;
 129
 130   croak("Conversion to invoices is only supported for sales records") unless $self->customer_id;
 131
 132   my $invoice;
 133   if (!$self->db->do_transaction(sub {
 134     require SL::DB::Invoice;
 135     $invoice = SL::DB::Invoice->new_from($self)->post(%params) || die;
 136     $self->link_to_record($invoice);
 137     $self->update_attributes(closed => 1);
 138     # die;
 139   })) {
 140     return undef;
 141   }
 142
 143   return $invoice;
 144 }
 145
 146 sub convert_to_delivery_order {
 147   my ($self, %params) = @_;
 148
 149   my ($delivery_order, $custom_shipto);
 150   if (!$self->db->do_transaction(sub {
 151     require SL::DB::DeliveryOrder;
 152     ($delivery_order, $custom_shipto) = SL::DB::DeliveryOrder->new_from($self);
 153     $delivery_order->save;
 154     $custom_shipto->save if $custom_shipto;
 155     $self->link_to_record($delivery_order);
 156     # die;
 157   })) {
 158     return undef;
 159   }
 160
 161   return wantarray ? ($delivery_order, $custom_shipto) : $delivery_order;
 162 }
 163
 164 sub number {
 165   my $self = shift;
 166
 167   my %number_method = (
 168     sales_order       => 'ordnumber',
 169     sales_quotation   => 'quonumber',
 170     purchase_order    => 'ordnumber',
 171     request_quotation => 'quonumber',
 172   );
 173
 174   return $self->${ \ $number_method{$self->type} }(@_);
 175 }
 176
 177 sub date {
 178   goto &transdate;
 179 }
 180
 181 1;
 182
 183 __END__
 184
 185 =head1 NAME
 186
 187 SL::DB::Order - Order Datenbank Objekt.
 188
 189 =head1 FUNCTIONS
 190
 191 =head2 C<type>
 192
 193 Returns one of the following string types:
 194
 195 =over 4
 196
 197 =item sales_order
 198
 199 =item purchase_order
 200
 201 =item sales_quotation
 202
 203 =item request_quotation
 204
 205 =back
 206
 207 =head2 C<is_type TYPE>
 208
 209 Returns true if the order is of the given type.
 210
 211 =head2 C<convert_to_delivery_order %params>
 212
 213 Creates a new delivery order with C<$self> as the basis by calling
 214 L<SL::DB::DeliveryOrder::new_from>. That delivery order is saved, and
 215 C<$self> is linked to the new invoice via L<SL::DB::RecordLink>.
 216
 217 The arguments in C<%params> are passed to
 218 L<SL::DB::DeliveryOrder::new_from>.
 219
 220 Returns C<undef> on failure. Otherwise the return value depends on the
 221 context. In list context the new delivery order and a shipto instance
 222 will be returned. In scalar instance only the delivery order instance
 223 is returned.
 224
 225 Custom shipto addresses (the ones specific to the sales/purchase
 226 record and not to the customer/vendor) are only linked from C<shipto>
 227 to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
 228 be filled in that case. That's why a separate shipto object is created
 229 and returned.
 230
 231 =head2 C<convert_to_invoice %params>
 232
 233 Creates a new invoice with C<$self> as the basis by calling
 234 L<SL::DB::Invoice::new_from>. That invoice is posted, and C<$self> is
 235 linked to the new invoice via L<SL::DB::RecordLink>. C<$self>'s
 236 C<closed> attribute is set to C<true>, and C<$self> is saved.
 237
 238 The arguments in C<%params> are passed to L<SL::DB::Invoice::post>.
 239
 240 Returns the new invoice instance on success and C<undef> on
 241 failure. The whole process is run inside a transaction. On failure
 242 nothing is created or changed in the database.
 243
 244 At the moment only sales quotations and sales orders can be converted.
 245
 246 =head2 C<create_sales_process>
 247
 248 Creates and saves a new sales process. Can only be called for sales
 249 orders.
 250
 251 The newly created process will be linked bidirectionally to both
 252 C<$self> and to all sales quotations that are linked to C<$self>.
 253
 254 Returns the newly created process instance.
 255
 256 =head1 BUGS
 257
 258 Nothing here yet.
 259
 260 =head1 AUTHOR
 261
 262 Sven Schöling <s.schoeling@linet-services.de>
 263
 264 =cut