Order: POD aufgeräumt, reformatiert, Bugs notiert.

[mfinanz.git] / SL / Controller / Order.pm

diff --git a/SL/Controller/Order.pm b/SL/Controller/Order.pm
index 8ed5b3326c43fb03dc396357eb04df4d450aec64..33185509888b6c9e2c7cffc0a14b86bf4354d9d9 100644 (file)
--- a/SL/Controller/Order.pm
+++ b/SL/Controller/Order.pm
@@ -3,36 +3,26 @@ package SL::Controller::Order;
 use strict;
 use parent qw(SL::Controller::Base);
 
 use strict;
 use parent qw(SL::Controller::Base);
 

-use SL::Helper::Flash;
+use SL::Helper::Flash qw(flash_later);

 use SL::Presenter;
 use SL::Presenter;

-use SL::Locale::String;
+use SL::Locale::String qw(t8);

 use SL::SessionFile::Random;
 use SL::PriceSource;
 use SL::SessionFile::Random;
 use SL::PriceSource;

-use SL::Form;

 use SL::Webdav;
 use SL::Webdav;

-use SL::Template;

 
 use SL::DB::Order;
 
 use SL::DB::Order;

-use SL::DB::Customer;
-use SL::DB::Vendor;
-use SL::DB::TaxZone;
-use SL::DB::Employee;
-use SL::DB::Project;

 use SL::DB::Default;
 use SL::DB::Unit;
 use SL::DB::Default;
 use SL::DB::Unit;

-use SL::DB::Price;
-use SL::DB::PriceFactor;

 use SL::DB::Part;
 use SL::DB::Printer;
 use SL::DB::Language;
 
 use SL::DB::Part;
 use SL::DB::Printer;
 use SL::DB::Language;
 

-use SL::Helper::DateTime;

 use SL::Helper::CreatePDF qw(:all);
 use SL::Helper::PrintOptions;
 
 use SL::Controller::Helper::GetModels;
 
 use SL::Helper::CreatePDF qw(:all);
 use SL::Helper::PrintOptions;
 
 use SL::Controller::Helper::GetModels;
 

-use List::Util qw(max first);
+use List::Util qw(first);

 use List::MoreUtils qw(none pairwise first_index);
 use English qw(-no_match_vars);
 use File::Spec;
 use List::MoreUtils qw(none pairwise first_index);
 use English qw(-no_match_vars);
 use File::Spec;


@@ -57,6 +47,7 @@ __PACKAGE__->run_before('_get_unalterable_data',
 # actions
 #
 
 # actions
 #
 

+# add a new order

 sub action_add {
   my ($self) = @_;
 
 sub action_add {
   my ($self) = @_;
 


@@ -73,6 +64,7 @@ sub action_add {
   );
 }
 
   );
 }
 

+# edit an existing order

 sub action_edit {
   my ($self) = @_;
 
 sub action_edit {
   my ($self) = @_;
 


@@ -88,6 +80,7 @@ sub action_edit {
   );
 }
 
   );
 }
 

+# delete the order

 sub action_delete {
   my ($self) = @_;
 
 sub action_delete {
   my ($self) = @_;
 


@@ -107,6 +100,7 @@ sub action_delete {
   $self->redirect_to(@redirect_params);
 }
 
   $self->redirect_to(@redirect_params);
 }
 

+# save the order

 sub action_save {
   my ($self) = @_;
 
 sub action_save {
   my ($self) = @_;
 


@@ -127,6 +121,14 @@ sub action_save {
   $self->redirect_to(@redirect_params);
 }
 
   $self->redirect_to(@redirect_params);
 }
 

+# print the order
+#
+# This is called if "print" is pressed in the print dialog.
+# If PDF creation was requested and succeeded, the pdf is stored in a session
+# file and the filename is stored as session value with an unique key. A
+# javascript function with this key is then called. This function calls the
+# download action below (action_download_pdf), which offers the file for
+# download.

 sub action_print {
   my ($self) = @_;
 
 sub action_print {
   my ($self) = @_;
 


@@ -211,6 +213,9 @@ sub action_print {
   $self->js->render;
 }
 
   $self->js->render;
 }
 

+# offer pdf for download
+#
+# It needs to get the key for the session value to get the pdf file.

 sub action_download_pdf {
   my ($self) = @_;
 
 sub action_download_pdf {
   my ($self) = @_;
 


@@ -223,6 +228,7 @@ sub action_download_pdf {
   );
 }
 
   );
 }
 

+# open the email dialog

 sub action_show_email_dialog {
   my ($self) = @_;
 
 sub action_show_email_dialog {
   my ($self) = @_;
 


@@ -257,6 +263,8 @@ sub action_show_email_dialog {
       ->render($self);
 }
 
       ->render($self);
 }
 

+# send email
+#

 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
 sub action_send_email {
   my ($self) = @_;
 # Todo: handling error messages: flash is not displayed in dialog, but in the main form
 sub action_send_email {
   my ($self) = @_;


@@ -296,6 +304,8 @@ sub action_send_email {
       ->render($self);
 }
 
       ->render($self);
 }
 

+# save the order and redirect to the frontend subroutine for a new
+# delivery order

 sub action_save_and_delivery_order {
   my ($self) = @_;
 
 sub action_save_and_delivery_order {
   my ($self) = @_;
 


@@ -316,6 +326,9 @@ sub action_save_and_delivery_order {
   $self->redirect_to(@redirect_params);
 }
 
   $self->redirect_to(@redirect_params);
 }
 

+# set form elements in respect of a changed customer or vendor
+#
+# This action is called on an change of the customer/vendor picker.

 sub action_customer_vendor_changed {
   my ($self) = @_;
 
 sub action_customer_vendor_changed {
   my ($self) = @_;
 


@@ -360,6 +373,7 @@ sub action_customer_vendor_changed {
   $self->js->render();
 }
 
   $self->js->render();
 }
 

+# called if a unit in an existing item row is changed

 sub action_unit_changed {
   my ($self) = @_;
 
 sub action_unit_changed {
   my ($self) = @_;
 


@@ -378,6 +392,7 @@ sub action_unit_changed {
   $self->js->render();
 }
 
   $self->js->render();
 }
 

+# add an item row for a new item entered in the input row

 sub action_add_item {
   my ($self) = @_;
 
 sub action_add_item {
   my ($self) = @_;
 


@@ -409,12 +424,14 @@ sub action_add_item {
   $self->js->render();
 }
 
   $self->js->render();
 }
 

+# open the dialog for entering multiple items at once

 sub action_show_multi_items_dialog {
   require SL::DB::PartsGroup;
   $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
                 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
 }
 
 sub action_show_multi_items_dialog {
   require SL::DB::PartsGroup;
   $_[0]->render('order/tabs/_multi_items_dialog', { layout => 0 },
                 all_partsgroups => SL::DB::Manager::PartsGroup->get_all);
 }
 

+# update the filter results in the multi item dialog

 sub action_multi_items_update_result {
   my $max_count = 100;
 
 sub action_multi_items_update_result {
   my $max_count = 100;
 


@@ -435,6 +452,7 @@ sub action_multi_items_update_result {
   }
 }
 
   }
 }
 

+# add item rows for multiple items add once

 sub action_add_multi_items {
   my ($self) = @_;
 
 sub action_add_multi_items {
   my ($self) = @_;
 


@@ -471,6 +489,7 @@ sub action_add_multi_items {
   $self->js->render();
 }
 
   $self->js->render();
 }
 

+# recalculate all linetotals, amounts and taxes and redisplay them

 sub action_recalc_amounts_and_taxes {
   my ($self) = @_;
 
 sub action_recalc_amounts_and_taxes {
   my ($self) = @_;
 


@@ -481,6 +500,7 @@ sub action_recalc_amounts_and_taxes {
   $self->js->render();
 }
 
   $self->js->render();
 }
 

+# redisplay item rows if the are sorted by an attribute

 sub action_reorder_items {
   my ($self) = @_;
 
 sub action_reorder_items {
   my ($self) = @_;
 


@@ -504,6 +524,7 @@ sub action_reorder_items {
     ->render;
 }
 
     ->render;
 }
 

+# show the popup to choose a price/discount source

 sub action_price_popup {
   my ($self) = @_;
 
 sub action_price_popup {
   my ($self) = @_;
 


@@ -513,6 +534,11 @@ sub action_price_popup {
   $self->render_price_dialog($item);
 }
 
   $self->render_price_dialog($item);
 }
 

+# get the longdescription for an item if the dialog to enter/change the
+# longdescription was opened and the longdescription is empty
+#
+# If this item is new, get the longdescription from Part.
+# Get it from OrderItem else.

 sub action_get_item_longdescription {
   my $longdescription;
 
 sub action_get_item_longdescription {
   my $longdescription;
 


@@ -524,7 +550,6 @@ sub action_get_item_longdescription {
   $_[0]->render(\ $longdescription, { type => 'text' });
 }
 
   $_[0]->render(\ $longdescription, { type => 'text' });
 }
 

-

 sub _js_redisplay_linetotals {
   my ($self) = @_;
 
 sub _js_redisplay_linetotals {
   my ($self) = @_;
 


@@ -591,6 +616,7 @@ sub init_order {
   $_[0]->_make_order;
 }
 
   $_[0]->_make_order;
 }
 

+# model used to filter/display the parts in the multi-items dialog

 sub init_multi_items_models {
   SL::Controller::Helper::GetModels->new(
     controller     => $_[0],
 sub init_multi_items_models {
   SL::Controller::Helper::GetModels->new(
     controller     => $_[0],


@@ -623,6 +649,9 @@ sub _check_auth {
   $::auth->assert($right);
 }
 
   $::auth->assert($right);
 }
 

+# build the selection box for contacts
+#
+# Needed, if customer/vendor changed.

 sub build_contact_select {
   my ($self) = @_;
 
 sub build_contact_select {
   my ($self) = @_;
 


@@ -635,6 +664,9 @@ sub build_contact_select {
   );
 }
 
   );
 }
 

+# build the selection box for shiptos
+#
+# Needed, if customer/vendor changed.

 sub build_shipto_select {
   my ($self) = @_;
 
 sub build_shipto_select {
   my ($self) = @_;
 


@@ -647,6 +679,9 @@ sub build_shipto_select {
   );
 }
 
   );
 }
 

+# build the rows for displaying taxes
+#
+# Called if amounts where recalculated and redisplayed.

 sub build_tax_rows {
   my ($self) = @_;
 
 sub build_tax_rows {
   my ($self) = @_;
 


@@ -687,6 +722,12 @@ sub _load_order {
   $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id}));
 }
 
   $self->order(SL::DB::Manager::Order->find_by(id => $::form->{id}));
 }
 

+# load or create a new order object
+#
+# And assign changes from the for to this object.
+# If the order is loaded from db, check if items are deleted in the form,
+# remove them form the object and collect them for removing from db on saving.
+# Then create/update items from form (via _make_item) and add them.

 sub _make_order {
   my ($self) = @_;
 
 sub _make_order {
   my ($self) = @_;
 


@@ -723,7 +764,8 @@ sub _make_order {
   return $order;
 }
 
   return $order;
 }
 

-
+# create or update items from form
+#

 # Make item objects from form values. For items already existing read from db.
 # Create a new item else. And assign attributes.
 sub _make_item {
 # Make item objects from form values. For items already existing read from db.
 # Create a new item else. And assign attributes.
 sub _make_item {


@@ -745,6 +787,9 @@ sub _make_item {
   return $item;
 }
 
   return $item;
 }
 

+# create a new item
+#
+# This is used to add one (or more) items

 sub _new_item {
   my ($record, $attr) = @_;
 
 sub _new_item {
   my ($record, $attr) = @_;
 


@@ -800,6 +845,9 @@ sub _new_item {
   return $item;
 }
 
   return $item;
 }
 

+# recalculate prices and taxes
+#
+# Using the PriceTaxCalculator. Store linetotals in the item objects.

 sub _recalc {
   my ($self) = @_;
 
 sub _recalc {
   my ($self) = @_;
 


@@ -820,7 +868,9 @@ sub _recalc {
   pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
 }
 
   pairwise { $a->{linetotal} = $b->{linetotal} } @{$self->order->items}, @{$pat{items}};
 }
 

-
+# get data for saving, printing, ..., that is not changed in the form
+#
+# Only cvars for now.

 sub _get_unalterable_data {
   my ($self) = @_;
 
 sub _get_unalterable_data {
   my ($self) = @_;
 


@@ -834,7 +884,9 @@ sub _get_unalterable_data {
   }
 }
 
   }
 }
 

-
+# delete the order
+#
+# And remove related files in the spool directory

 sub _delete {
   my ($self) = @_;
 
 sub _delete {
   my ($self) = @_;
 


@@ -854,7 +906,9 @@ sub _delete {
   return $errors;
 }
 
   return $errors;
 }
 

-
+# save the order
+#
+# And delete items that are deleted in the form.

 sub _save {
   my ($self) = @_;
 
 sub _save {
   my ($self) = @_;
 


@@ -942,8 +996,6 @@ sub _create_pdf {
   $print_form->{language_id} = $params->{language}->id            if $print_form->{language};
 
   $order->flatten_to_form($print_form, format_amounts => 1);
   $print_form->{language_id} = $params->{language}->id            if $print_form->{language};
 
   $order->flatten_to_form($print_form, format_amounts => 1);

-  # flatten_to_form sets payment_terms from customer/vendor - we do not want that here
-  delete $print_form->{payment_terms} if !$print_form->{payment_id};

 
   # search for the template
   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(
 
   # search for the template
   my ($template_file, @template_files) = SL::Helper::CreatePDF->find_template(


@@ -997,79 +1049,192 @@ __END__
 
 SL::Controller::Order - controller for orders
 
 
 SL::Controller::Order - controller for orders
 

-=head1 TODO
+=head1 SYNOPSIS

 
 

-=over 2
+This is a new form to enter orders, completely rewritten with the use
+of controller and java script techniques.

 
 

-=item *
+The aim is to provide the user a better expirience and a faster flow
+of work. Also the code should be more readable, more reliable and
+better to maintain.

 
 

-testing
+=head2 Key Features

 
 

+=over 4

 
 =item *
 
 
 =item *
 

-currency
-
+One input row, so that input happens every time at the same place.

 
 =item *
 
 
 =item *
 

-customer/vendor details ('D'-button)
+Use of pickers where possible.
+
+=item *

 
 

+Possibility to enter more than one item at once.

 
 =item *
 
 
 =item *
 

-credit limit
+Save order only on "save" (and "save and delivery order"-workflow). No
+hidden save on "print" or "email".
+
+=item *

 
 

+Item list in a scrollable area, so that the workflow buttons stay at
+the bottom.

 
 =item *
 
 
 =item *
 

-more workflows (save as new / invoice)
+Reordering item rows with drag and drop is possible. Sorting item rows is
+possible (by partnumber, description, qty, sellprice and discount for now).

 
 

+=item *
+
+No C<update> is necessary. All entries and calculations are managed
+with ajax-calls and the page does only reload on C<save>.

 
 =item *
 
 
 =item *
 

-price sources: little symbols showing better price / better discount
+User can see changes immediately, because of the use of java script
+and ajax.

 
 

+=back

 
 

-=item *
+=head1 CODE

 
 

-custom shipto address
+=head2 Layout

 
 

+=over 4

 
 

-=item *
+=item * C<SL/Controller/Order.pm>

 
 

-periodic invoices
+the controller

 
 

+=item * C<template/webpages/order/form.html>

 
 

-=item *
+main form
+
+=item * C<template/webpages/order/tabs/basic_data.html>
+
+Main tab for basic_data.
+
+This is the only tab here for now. "linked records" and "webdav" tabs are
+reused from generic code.
+
+=over 4
+
+=item * C<template/webpages/order/tabs/_item_input.html>
+
+The input line for items
+
+=item * C<template/webpages/order/tabs/_row.html>
+
+One row for already entered items
+
+=item * C<template/webpages/order/tabs/_tax_row.html>

 
 

-more details on second row (marge, ...)
+Displaying tax information

 
 

+=item * C<template/webpages/order/tabs/_multi_items_dialog.html>
+
+Dialog for entering more than one item at once
+
+=item * C<template/webpages/order/tabs/_multi_items_result.html>
+
+Results for the filter in the multi items dialog
+
+=item * C<template/webpages/order/tabs/_price_sources_dialog.html>
+
+Dialog for selecting price and discount sources
+
+=item * C<template/webpages/order/tabs/_email_dialog.html>
+
+Email dialog
+
+=back

 
 =item *
 
 
 =item *
 

-language / part translations
+js/kivi.Order.js: java script functions
+
+=back
+
+=head1 TODO
+
+=over 4
+
+=item * testing
+
+=item * currency
+
+=item * customer/vendor details ('D'-button)
+
+=item * credit limit
+
+=item * more workflows (save as new / invoice)
+
+=item * price sources: little symbols showing better price / better discount
+
+=item * custom shipto address

 
 

+=item * periodic invoices
+
+=item * more details on second row (marge, ...)
+
+=item * language / part translations
+
+=item * access rights
+
+=item * preset salesman from customer
+
+=item * display weights
+
+=item * force project if enabled in client config
+
+=back
+
+=head1 KNOWN BUGS AND CAVEATS
+
+=over 4

 
 =item *
 
 
 =item *
 

-access rights
+C<position> is not displayed until an order is saved

 
 

+=item *
+
+Customer discount is not displayed as a valid discount in price source popup
+(this might be a bug in price sources)

 
 =item *
 
 
 =item *
 

-preset salesman from customer
+No indication that double click expands second row, no exand all button
+
+=item *
+
+Implementation of second row with a tbody for every item is not supported by
+our css.
+
+=item *

 
 

+As a consequence row striping does not currently work

 
 =item *
 
 
 =item *
 

-display weights
+Inline creation of parts is not currently supported
+
+=item *

 
 

+Table header is not sticky in the scrolling area.

 
 =item *
 
 
 =item *
 

-force project if enabled in client config
+Sorting does not include C<position>, neither does reordering.
+
+=item *

 
 

+C<show_smulti_items_dialog> does not use the currently inserted string for filtering.

 
 =back
 
 
 =back