1 package SL::Presenter::Part;
6 use SL::DB::Manager::PartsClassification;
8 use Exporter qw(import);
9 our @EXPORT = qw(part_picker part select_classification classification_abbreviation type_abbreviation separate_abbreviation);
14 my ($self, $part, %params) = @_;
16 $params{display} ||= 'inline';
18 croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
21 $params{no_link} ? '' : '<a href="controller.pl?action=Part/edit&part.id=' . $self->escape($part->id) . '">',
22 $self->escape($part->partnumber),
23 $params{no_link} ? '' : '</a>',
25 return $self->escaped_text($text);
29 my ($self, $name, $value, %params) = @_;
31 $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value;
32 my $id = delete($params{id}) || $self->name_to_id($name);
33 my $fat_set_item = delete $params{fat_set_item};
35 my @classes = $params{class} ? ($params{class}) : ();
36 push @classes, 'part_autocomplete';
37 push @classes, 'partpicker_fat_set_item' if $fat_set_item;
40 $self->input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id) .
41 join('', map { $params{$_} ? $self->input_tag("", delete $params{$_}, id => "${id}_${_}", type => 'hidden') : '' } qw(part_type unit convertible_unit)) .
42 $self->input_tag("", ref $value ? $value->displayable_name : '', id => "${id}_name", %params);
44 $::request->layout->add_javascripts('autocomplete_part.js');
45 $::request->presenter->need_reinit_widgets($id);
47 $self->html_tag('span', $ret, class => 'part_picker');
51 # Must be addapted to new type table
53 sub type_abbreviation {
54 my ($self, $part_type) = @_;
55 $main::lxdebug->message(LXDebug->DEBUG2(),"parttype=".$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')
77 sub classification_abbreviation {
79 $main::lxdebug->message(LXDebug->DEBUG2(),"classif=".$id);
80 return $::locale->text(SL::DB::Manager::PartsClassification->get_abbreviation($id));
83 sub separate_abbreviation {
85 return $::locale->text(SL::DB::Manager::PartsClassification->get_separate_abbreviation($id));
88 sub select_classification {
89 my ($self, $name, %attributes) = @_;
90 $attributes{value_key} = 'id';
91 $attributes{title_key} = 'description';
92 my $collection = SL::DB::Manager::PartsClassification->get_all_sorted();
93 $_->description($::locale->text($_->description)) for @{ $collection };
94 return $self->select_tag( $name, $collection, %attributes );
105 SL::Presenter::Part - Part related presenter stuff
109 # Create an html link for editing/opening a part/service/assembly
110 my $object = my $object = SL::DB::Manager::Part->get_first;
111 my $html = SL::Presenter->get->part($object, display => 'inline');
113 see also L<SL::Presenter>
123 =item C<part, $object, %params>
125 Returns a rendered version (actually an instance of
126 L<SL::Presenter::EscapedText>) of the part object C<$object>
128 C<%params> can include:
134 Either C<inline> (the default) or C<table-cell>. At the moment both
135 representations are identical and produce the part's name linked
136 to the corresponding 'edit' action.
144 =item C<part_picker $name, $value, %params>
146 All-in-one picker widget for parts. The name will be both id and name
147 of the resulting hidden C<id> input field (but the ID can be
148 overwritten with C<$params{id}>).
150 An additional dummy input will be generated which is used to find
151 parts. For a detailed description of its behaviour, see section
152 C<PART PICKER SPECIFICATION>.
154 C<$value> can be a parts id or a C<Rose::DB:Object> instance.
156 If C<%params> contains C<part_type> only parts of this type will be used
157 for autocompletion. You may comma separate multiple types as in
160 If C<%params> contains C<unit> only parts with this unit will be used
161 for autocompletion. You may comma separate multiple units as in
164 If C<%params> contains C<convertible_unit> only parts with a unit
165 that's convertible to unit will be used for autocompletion.
167 Obsolete parts will by default not be displayed for selection. However they are
168 accepted as default values and can persist during updates. As with other
169 selectors though, they are not selectable once overridden.
171 C<part_picker> will register it's javascript for inclusion in the next header
172 rendering. If you write a standard controller that only call C<render> once, it
173 will just work. In case the header is generated in a different render call
174 (multiple blocks, ajax, old C<bin/mozilla> style controllers) you need to
175 include C<js/autocomplete_part.js> yourself.
179 =head1 PART PICKER SPECIFICATION
181 The following list of design goals were applied:
187 Parts should not be perceived by the user as distinct inputs of partnumber and
188 description but as a single object
192 Easy to use without documentation for novice users
196 Fast to use with keyboard for experienced users
200 Possible to use without any keyboard interaction for mouse (or touchscreen)
205 Must not leave the current page in event of ambiguity (cf. current select_item
210 Should be useable with hand scanners or similar alternative keyboard devices
214 Should not require a feedback/check loop in the common case
218 Should not be constrained to exact matches
222 The implementation consists of the following parts which will be referenced later:
228 A hidden input (id input), used to hold the id of the selected part. The only
229 input that gets submitted
233 An input (dummy input) containing a description of the currently selected part,
234 also used by the user to search for parts
238 A jquery.autocomplete mechanism attached to the dummy field
242 A popup layer for both feedback and input of additional data in case of
247 An internal status of the part picker, indicating whether id input and dummy
248 input are consistent. After leaving the dummy input the part picker must
249 place itself in a consistent status.
253 A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
263 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>