1 package SL::Presenter::Part;
6 use SL::DB::PartClassification;
7 use SL::Locale::String qw(t8);
8 use SL::Presenter::EscapedText qw(escape is_escaped);
9 use SL::Presenter::Tag qw(input_tag html_tag name_to_id select_tag);
11 use Exporter qw(import);
13 part_picker part select_classification classification_abbreviation
14 type_abbreviation separate_abbreviation typeclass_abbreviation
16 our %EXPORT_TAGS = (ALL => \@EXPORT_OK);
21 my ($part, %params) = @_;
23 $params{display} ||= 'inline';
25 croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
28 $params{no_link} ? '' : '<a href="controller.pl?action=Part/edit&part.id=' . escape($part->id) . '">',
29 escape($part->partnumber),
30 $params{no_link} ? '' : '</a>',
37 my ($name, $value, %params) = @_;
39 $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value;
40 my $id = $params{id} || name_to_id($name);
42 my @classes = $params{class} ? ($params{class}) : ();
43 push @classes, 'part_autocomplete';
46 input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id,
47 'data-part-picker-data' => JSON::to_json(\%params),
49 input_tag("", ref $value ? $value->displayable_name : '', id => "${id}_name", %params);
51 $::request->layout->add_javascripts('kivi.Part.js');
52 $::request->presenter->need_reinit_widgets($id);
54 html_tag('span', $ret, class => 'part_picker');
57 sub picker { goto &part_picker }
60 # shortcut for article type
62 sub type_abbreviation {
65 return '' if !$part_type;
66 return $::locale->text('Assembly (typeabbreviation)') if $part_type eq 'assembly';
67 return $::locale->text('Part (typeabbreviation)') if $part_type eq 'part';
68 return $::locale->text('Assortment (typeabbreviation)') if $part_type eq 'assortment';
69 return $::locale->text('Service (typeabbreviation)');
73 # Translations for Abbreviations:
75 # $::locale->text('None (typeabbreviation)')
76 # $::locale->text('Purchase (typeabbreviation)')
77 # $::locale->text('Sales (typeabbreviation)')
78 # $::locale->text('Merchandise (typeabbreviation)')
79 # $::locale->text('Production (typeabbreviation)')
81 # and for descriptions
82 # $::locale->text('Purchase')
83 # $::locale->text('Sales')
84 # $::locale->text('Merchandise')
85 # $::locale->text('Production')
88 # shortcut for article type
90 sub classification_abbreviation {
95 SL::DB::Manager::PartClassification->cache_all();
96 my $obj = SL::DB::PartClassification->load_cached($id);
97 $obj && $obj->abbreviation ? t8($obj->abbreviation) : '';
100 sub typeclass_abbreviation {
102 return '' if !$part || !$part->isa('SL::DB::Part');
103 return type_abbreviation($part->part_type) . classification_abbreviation($part->classification_id);
107 # shortcut for article type
109 sub separate_abbreviation {
114 SL::DB::Manager::PartClassification->cache_all();
115 my $obj = SL::DB::PartClassification->load_cached($id);
116 $obj && $obj->abbreviation && $obj->report_separate ? t8($obj->abbreviation) : '';
120 # generate selection tag
122 sub select_classification {
123 my ($name, %attributes) = @_;
125 $attributes{value_key} = 'id';
126 $attributes{title_key} = 'description';
128 my $classification_type_filter = delete $attributes{type} // [];
130 my $collection = SL::DB::Manager::PartClassification->get_all_sorted( where => $classification_type_filter );
131 $_->description($::locale->text($_->description)) for @{ $collection };
132 select_tag( $name, $collection, %attributes );
143 SL::Presenter::Part - Part related presenter stuff
147 # Create an html link for editing/opening a part/service/assembly
148 my $object = SL::DB::Manager::Part->get_first;
149 my $html = SL::Presenter->get->part($object, display => 'inline');
151 see also L<SL::Presenter>
161 =item C<part, $object, %params>
163 Returns a rendered version (actually an instance of
164 L<SL::Presenter::EscapedText>) of the part object C<$object>
166 C<%params> can include:
172 Either C<inline> (the default) or C<table-cell>. At the moment both
173 representations are identical and produce the part's name linked
174 to the corresponding 'edit' action.
182 =item C<classification_abbreviation $classification_id>
184 Returns the shortcut of the classification
190 =item C<separate_abbreviation $classification_id>
192 Returns the shortcut of the classification if the classification has the separate flag set.
198 =item C<select_classification $name,%params>
200 Returns an HTML select tag with all available classifications.
202 C<%params> can include:
208 The id of the selected item.
216 =item C<part_picker $name, $value, %params>
218 All-in-one picker widget for parts. The name will be both id and name
219 of the resulting hidden C<id> input field (but the ID can be
220 overwritten with C<$params{id}>).
222 An additional dummy input will be generated which is used to find
223 parts. For a detailed description of its behaviour, see section
224 C<PART PICKER SPECIFICATION>.
226 C<$value> can be a parts id or a C<Rose::DB:Object> instance.
228 If C<%params> contains C<part_type> only parts of this type will be used
229 for autocompletion. You may comma separate multiple types as in
232 If C<%params> contains C<status> only parts of this status will be used
233 for autocompletion. C<status> can be one of the following strings:
234 C<active>, C<obsolete> or C<all>. C<active> is the default if C<status> is
237 If C<%params> contains C<unit> only parts with this unit will be used
238 for autocompletion. You may comma separate multiple units as in
241 If C<%params> contains C<convertible_unit> only parts with a unit
242 that's convertible to unit will be used for autocompletion.
244 If C<%params> contains C<with_makemodel> or C<with_customer_partnumber> even
245 parts will be used for autocompletion which partnumber is a vendor partnumber
246 (makemodel) or a customer partnumber.
248 If C<%params> contains C<multiple> an alternative popup will be opened,
249 allowing multiple items to be selected. Note however that this requires
250 an additional callback C<set_multi_items> to work.
251 Also note that you can set C<multiple> to 0 (or not set C<multiple>) on
252 creation of the picker, but can open the alternative multi select popup
254 C<$("#pp_id").data("part_picker").o.multiple=1; $("#pp_id").data("part_picker").open_dialog()'>
255 where C<pp_id> is the dom id of the part picker.
256 Or you can even do it the other way round setting C<multiple> to 1 on creation
257 and open a single selection popup with js.
259 Obsolete parts will by default not be displayed for selection. However they are
260 accepted as default values and can persist during updates. As with other
261 selectors though, they are not selectable once overridden.
263 C<part_picker> will register it's javascript for inclusion in the next header
264 rendering. If you write a standard controller that only calls C<render> once, it
265 will just work. In case the header is generated in a different render call
266 (multiple blocks, ajax, old C<bin/mozilla> style controllers) you need to
267 include C<kivi.Part.js> yourself.
269 On pressing <enter> the picker will try to commit the current selection,
270 resulting in one of the following events, whose corresponding callbacks can be
271 set in C<params.actions>:
275 =item * C<commit_one>
277 If exactly one element matches the input, the internal id will be set to this
278 id, the internal state will be set to C<PICKED> and the C<change> event on the
279 picker will be fired. Additionally, if C<params> contains C<fat_set_item> a
280 special event C<set_item:PartPicker> will be fired which is guaranteed to
281 contain a complete JSON representation of the part.
283 After that the action C<commit_one> will be executed, which defaults to
284 clicking a button with id C<update_button> for backward compatibility reasons.
286 =item * C<commit_many>
288 If more than one element matches the input, the internal state will be set to
291 After that the action C<commit_one> will be executed, which defaults to
292 opening a popup dialog for graphical interaction.
294 =item * C<commit_none>
296 If no element matches the input, the internal state will be set to undefined.
298 If an action for C<commit_none> exists, it will be called with the picker
299 object and current term. The caller can then implement creation of new parts.
305 =head1 PART PICKER SPECIFICATION
307 The following list of design goals were applied:
313 Parts should not be perceived by the user as distinct inputs of partnumber and
314 description but as a single object
318 Easy to use without documentation for novice users
322 Fast to use with keyboard for experienced users
326 Possible to use without any keyboard interaction for mouse (or touchscreen)
331 Must not leave the current page in event of ambiguity (cf. current select_item
336 Should be useable with hand scanners or similar alternative keyboard devices
340 Should not require a feedback/check loop in the common case
344 Should not be constrained to exact matches
352 Action should be overridable
356 The implementation consists of the following parts which will be referenced later:
362 A hidden input (id input), used to hold the id of the selected part. The only
363 input that gets submitted
367 An input (dummy input) containing a description of the currently selected part,
368 also used by the user to search for parts
372 A jquery.autocomplete mechanism attached to the dummy field
376 A popup layer for both feedback and input of additional data in case of
381 An internal status of the part picker, indicating whether id input and dummy
382 input are consistent. After leaving the dummy input the part picker must
383 place itself in a consistent status.
387 A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
397 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
399 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>