1 package SL::Presenter::Part;
6 use SL::DB::PartClassification;
7 use SL::Locale::String qw(t8);
9 use Exporter qw(import);
10 our @EXPORT = qw(part_picker part select_classification classification_abbreviation type_abbreviation separate_abbreviation typeclass_abbreviation);
15 my ($self, $part, %params) = @_;
17 $params{display} ||= 'inline';
19 croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
22 $params{no_link} ? '' : '<a href="controller.pl?action=Part/edit&part.id=' . $self->escape($part->id) . '">',
23 $self->escape($part->partnumber),
24 $params{no_link} ? '' : '</a>',
26 return $self->escaped_text($text);
30 my ($self, $name, $value, %params) = @_;
32 $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value;
33 my $id = delete($params{id}) || $self->name_to_id($name);
34 my $fat_set_item = delete $params{fat_set_item};
36 my @classes = $params{class} ? ($params{class}) : ();
37 push @classes, 'part_autocomplete';
38 push @classes, 'partpicker_fat_set_item' if $fat_set_item;
41 $self->input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id) .
42 join('', map { $params{$_} ? $self->input_tag("", delete $params{$_}, id => "${id}_${_}", type => 'hidden') : '' } qw(part_type classification_id unit convertible_unit)) .
43 $self->input_tag("", ref $value ? $value->displayable_name : '', id => "${id}_name", %params);
45 $::request->layout->add_javascripts('autocomplete_part.js');
46 $::request->presenter->need_reinit_widgets($id);
48 $self->html_tag('span', $ret, class => 'part_picker');
52 # shortcut for article type
54 sub type_abbreviation {
55 my ($self, $part_type) = @_;
56 return $::locale->text('Assembly (typeabbreviation)') if $part_type eq 'assembly';
57 return $::locale->text('Part (typeabbreviation)') if $part_type eq 'part';
58 return $::locale->text('Assortment (typeabbreviation)') if $part_type eq 'assortment';
59 return $::locale->text('Service (typeabbreviation)');
63 # Translations for Abbreviations:
65 # $::locale->text('None (typeabbreviation)')
66 # $::locale->text('Purchase (typeabbreviation)')
67 # $::locale->text('Sales (typeabbreviation)')
68 # $::locale->text('Merchandise (typeabbreviation)')
69 # $::locale->text('Production (typeabbreviation)')
71 # and for descriptions
72 # $::locale->text('Purchase')
73 # $::locale->text('Sales')
74 # $::locale->text('Merchandise')
75 # $::locale->text('Production')
78 # shortcut for article type
80 sub classification_abbreviation {
82 SL::DB::Manager::PartClassification->cache_all();
83 my $obj = SL::DB::PartClassification->load_cached($id);
84 $obj && $obj->abbreviation ? t8($obj->abbreviation) : '';
87 sub typeclass_abbreviation {
88 my ($self, $part) = @_;
89 return '' if !$part || !$part->isa('SL::DB::Part');
90 return $self->type_abbreviation($part->part_type).$self->classification_abbreviation($part->classification_id);
94 # shortcut for article type
96 sub separate_abbreviation {
98 SL::DB::Manager::PartClassification->cache_all();
99 my $obj = SL::DB::PartClassification->load_cached($id);
100 $obj && $obj->abbreviation && $obj->report_separate ? t8($obj->abbreviation) : '';
104 # generate selection tag
106 sub select_classification {
107 my ($self, $name, %attributes) = @_;
108 $attributes{value_key} = 'id';
109 $attributes{title_key} = 'description';
110 my $collection = SL::DB::Manager::PartClassification->get_all_sorted();
111 $_->description($::locale->text($_->description)) for @{ $collection };
112 return $self->select_tag( $name, $collection, %attributes );
123 SL::Presenter::Part - Part related presenter stuff
127 # Create an html link for editing/opening a part/service/assembly
128 my $object = my $object = SL::DB::Manager::Part->get_first;
129 my $html = SL::Presenter->get->part($object, display => 'inline');
131 see also L<SL::Presenter>
141 =item C<part, $object, %params>
143 Returns a rendered version (actually an instance of
144 L<SL::Presenter::EscapedText>) of the part object C<$object>
146 C<%params> can include:
152 Either C<inline> (the default) or C<table-cell>. At the moment both
153 representations are identical and produce the part's name linked
154 to the corresponding 'edit' action.
162 =item C<classification_abbreviation $classification_id>
164 Returns the shortcut of the classification
170 =item C<separate_abbreviation $classification_id>
172 Returns the shortcut of the classification if the classifiaction has the separate flag set.
178 =item C<select_classification $name,%params>
180 Returns a HTML Select Tag with all available Classifications
182 C<%params> can include:
188 The Id of the selected item .
196 =item C<part_picker $name, $value, %params>
198 All-in-one picker widget for parts. The name will be both id and name
199 of the resulting hidden C<id> input field (but the ID can be
200 overwritten with C<$params{id}>).
202 An additional dummy input will be generated which is used to find
203 parts. For a detailed description of its behaviour, see section
204 C<PART PICKER SPECIFICATION>.
206 C<$value> can be a parts id or a C<Rose::DB:Object> instance.
208 If C<%params> contains C<part_type> only parts of this type will be used
209 for autocompletion. You may comma separate multiple types as in
212 If C<%params> contains C<unit> only parts with this unit will be used
213 for autocompletion. You may comma separate multiple units as in
216 If C<%params> contains C<convertible_unit> only parts with a unit
217 that's convertible to unit will be used for autocompletion.
219 Obsolete parts will by default not be displayed for selection. However they are
220 accepted as default values and can persist during updates. As with other
221 selectors though, they are not selectable once overridden.
223 C<part_picker> will register it's javascript for inclusion in the next header
224 rendering. If you write a standard controller that only call C<render> once, it
225 will just work. In case the header is generated in a different render call
226 (multiple blocks, ajax, old C<bin/mozilla> style controllers) you need to
227 include C<js/autocomplete_part.js> yourself.
231 =head1 PART PICKER SPECIFICATION
233 The following list of design goals were applied:
239 Parts should not be perceived by the user as distinct inputs of partnumber and
240 description but as a single object
244 Easy to use without documentation for novice users
248 Fast to use with keyboard for experienced users
252 Possible to use without any keyboard interaction for mouse (or touchscreen)
257 Must not leave the current page in event of ambiguity (cf. current select_item
262 Should be useable with hand scanners or similar alternative keyboard devices
266 Should not require a feedback/check loop in the common case
270 Should not be constrained to exact matches
274 The implementation consists of the following parts which will be referenced later:
280 A hidden input (id input), used to hold the id of the selected part. The only
281 input that gets submitted
285 An input (dummy input) containing a description of the currently selected part,
286 also used by the user to search for parts
290 A jquery.autocomplete mechanism attached to the dummy field
294 A popup layer for both feedback and input of additional data in case of
299 An internal status of the part picker, indicating whether id input and dummy
300 input are consistent. After leaving the dummy input the part picker must
301 place itself in a consistent status.
305 A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
315 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
317 Martin Helmling E<lt>martin.helmling@opendynamic.deE<gt>