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