SL/Presenter/DeliveryOrder.pm

   1 package SL::Presenter::DeliveryOrder;
   2
   3 use strict;
   4
   5 use SL::Presenter::EscapedText qw(escape is_escaped);
   6
   7 use Exporter qw(import);
   8 our @EXPORT_OK = qw(sales_delivery_order purchase_delivery_order);
   9
  10 use Carp;
  11
  12 sub sales_delivery_order {
  13   my ($delivery_order, %params) = @_;
  14
  15   return _do_record($delivery_order, 'sales_delivery_order', %params);
  16 }
  17
  18 sub purchase_delivery_order {
  19   my ($delivery_order, %params) = @_;
  20
  21   return _do_record($delivery_order, 'purchase_delivery_order', %params);
  22 }
  23
  24 sub _do_record {
  25   my ($delivery_order, $type, %params) = @_;
  26
  27   $params{display} ||= 'inline';
  28
  29   croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
  30
  31   my $text = join '', (
  32     $params{no_link} ? '' : '<a href="do.pl?action=edit&amp;type=' . $type . '&amp;id=' . escape($delivery_order->id) . '">',
  33     escape($delivery_order->donumber),
  34     $params{no_link} ? '' : '</a>',
  35   );
  36   is_escaped($text);
  37 }
  38
  39 1;
  40
  41 __END__
  42
  43 =pod
  44
  45 =encoding utf8
  46
  47 =head1 NAME
  48
  49 SL::Presenter::DeliveryOrder - Presenter module for Rose::DB objects
  50 for sales and purchase delivery orders
  51
  52 =head1 SYNOPSIS
  53
  54   # Sales delivery orders:
  55   my $object = SL::DB::Manager::DeliveryOrder->get_first(where => [ is_sales => 1 ]);
  56   my $html   = SL::Presenter::DeliveryOrder::sales_delivery_order($object, display => 'inline');
  57
  58   # Purchase delivery orders:
  59   my $object = SL::DB::Manager::DeliveryOrder->get_first(where => [ or => [ is_sales => undef, is_sales => 0 ]]);
  60   my $html   = SL::Presenter::DeliveryOrder::purchase_delivery_order($object, display => 'inline');
  61
  62 =head1 FUNCTIONS
  63
  64 =over 4
  65
  66 =item C<sales_delivery_order $object, %params>
  67
  68 Returns a rendered version (actually an instance of
  69 L<SL::Presenter::EscapedText>) of the sales delivery order object
  70 C<$object>.
  71
  72 C<%params> can include:
  73
  74 =over 2
  75
  76 =item * display
  77
  78 Either C<inline> (the default) or C<table-cell>. At the moment both
  79 representations are identical and produce the objects's delivery
  80 order number linked to the corresponding 'edit' action.
  81
  82 =item * no_link
  83
  84 If falsish (the default) then the delivery order number will be linked
  85 to the "edit delivery order" dialog from the sales menu.
  86
  87 =back
  88
  89 =item C<purchase_delivery_order $object, %params>
  90
  91 Returns a rendered version (actually an instance of
  92 L<SL::Presenter::EscapedText>) of the purchase delivery order object
  93 C<$object>.
  94
  95 C<%params> can include:
  96
  97 =over 2
  98
  99 =item * display
 100
 101 Either C<inline> (the default) or C<table-cell>. At the moment both
 102 representations are identical and produce the objects's delivery
 103 order number linked to the corresponding 'edit' action.
 104
 105 =item * no_link
 106
 107 If falsish (the default) then the delivery order number will be linked
 108 to the "edit delivery order" dialog from the purchase menu.
 109
 110 =back
 111
 112 =back
 113
 114 =head1 BUGS
 115
 116 Nothing here yet.
 117
 118 =head1 AUTHOR
 119
 120 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 121
 122 =cut