SL/Presenter/Part.pm

   1 package SL::Presenter::Part;
   2
   3 use strict;
   4
   5 use SL::DB::Part;
   6 use SL::DB::Manager::PartsClassification;
   7
   8 use Exporter qw(import);
   9 our @EXPORT = qw(part_picker part select_classification classification_abbreviation type_abbreviation type_and_classification);
  10
  11 use Carp;
  12
  13 sub part {
  14   my ($self, $part, %params) = @_;
  15
  16   $params{display} ||= 'inline';
  17
  18   croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
  19
  20   my $text = join '', (
  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>',
  24   );
  25   return $self->escaped_text($text);
  26 }
  27
  28 sub part_picker {
  29   my ($self, $name, $value, %params) = @_;
  30
  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};
  34
  35   my @classes = $params{class} ? ($params{class}) : ();
  36   push @classes, 'part_autocomplete';
  37   push @classes, 'partpicker_fat_set_item' if $fat_set_item;
  38
  39   my $ret =
  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);
  43
  44   $::request->layout->add_javascripts('autocomplete_part.js');
  45   $::request->presenter->need_reinit_widgets($id);
  46
  47   $self->html_tag('span', $ret, class => 'part_picker');
  48 }
  49
  50 #
  51 # Must be addapted to new type table
  52 #
  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)');
  60 }
  61
  62 #
  63 # Translations for Abbreviations:
  64 #
  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)')
  70 #
  71 # and for descriptions
  72 # $::locale->text('Purchase')
  73 # $::locale->text('Sales')
  74 # $::locale->text('Merchandise')
  75 # $::locale->text('Production')
  76
  77 sub classification_abbreviation {
  78   my ($self, $id) = @_;
  79   $main::lxdebug->message(LXDebug->DEBUG2(),"classif=".$id);
  80   return $::locale->text(SL::DB::Manager::PartsClassification->get_abbreviation($id));
  81 }
  82
  83 sub select_classification {
  84   my ($self, $name, %attributes) = @_;
  85   $attributes{value_key} = 'id';
  86   $attributes{title_key} = 'description';
  87   my $collection = SL::DB::Manager::PartsClassification->get_all_sorted();
  88   $_->description($::locale->text($_->description)) for @{ $collection };
  89   return $self->select_tag( $name, $collection, %attributes );
  90 }
  91
  92 1;
  93
  94 __END__
  95
  96 =encoding utf-8
  97
  98 =head1 NAME
  99
 100 SL::Presenter::Part - Part related presenter stuff
 101
 102 =head1 SYNOPSIS
 103
 104   # Create an html link for editing/opening a part/service/assembly
 105   my $object = my $object = SL::DB::Manager::Part->get_first;
 106   my $html   = SL::Presenter->get->part($object, display => 'inline');
 107
 108 see also L<SL::Presenter>
 109
 110 =head1 DESCRIPTION
 111
 112 see L<SL::Presenter>
 113
 114 =head1 FUNCTIONS
 115
 116 =over 2
 117
 118 =item C<part, $object, %params>
 119
 120 Returns a rendered version (actually an instance of
 121 L<SL::Presenter::EscapedText>) of the part object C<$object>
 122
 123 C<%params> can include:
 124
 125 =over 4
 126
 127 =item * display
 128
 129 Either C<inline> (the default) or C<table-cell>. At the moment both
 130 representations are identical and produce the part's name linked
 131 to the corresponding 'edit' action.
 132
 133 =back
 134
 135 =back
 136
 137 =over 2
 138
 139 =item C<part_picker $name, $value, %params>
 140
 141 All-in-one picker widget for parts. The name will be both id and name
 142 of the resulting hidden C<id> input field (but the ID can be
 143 overwritten with C<$params{id}>).
 144
 145 An additional dummy input will be generated which is used to find
 146 parts. For a detailed description of its behaviour, see section
 147 C<PART PICKER SPECIFICATION>.
 148
 149 C<$value> can be a parts id or a C<Rose::DB:Object> instance.
 150
 151 If C<%params> contains C<part_type> only parts of this type will be used
 152 for autocompletion. You may comma separate multiple types as in
 153 C<part,assembly>.
 154
 155 If C<%params> contains C<unit> only parts with this unit will be used
 156 for autocompletion. You may comma separate multiple units as in
 157 C<h,min>.
 158
 159 If C<%params> contains C<convertible_unit> only parts with a unit
 160 that's convertible to unit will be used for autocompletion.
 161
 162 Obsolete parts will by default not be displayed for selection. However they are
 163 accepted as default values and can persist during updates. As with other
 164 selectors though, they are not selectable once overridden.
 165
 166 C<part_picker> will register it's javascript for inclusion in the next header
 167 rendering. If you write a standard controller that only call C<render> once, it
 168 will just work.  In case the header is generated in a different render call
 169 (multiple blocks, ajax, old C<bin/mozilla> style controllers) you need to
 170 include C<js/autocomplete_part.js> yourself.
 171
 172 =back
 173
 174 =head1 PART PICKER SPECIFICATION
 175
 176 The following list of design goals were applied:
 177
 178 =over 4
 179
 180 =item *
 181
 182 Parts should not be perceived by the user as distinct inputs of partnumber and
 183 description but as a single object
 184
 185 =item *
 186
 187 Easy to use without documentation for novice users
 188
 189 =item *
 190
 191 Fast to use with keyboard for experienced users
 192
 193 =item *
 194
 195 Possible to use without any keyboard interaction for mouse (or touchscreen)
 196 users
 197
 198 =item *
 199
 200 Must not leave the current page in event of ambiguity (cf. current select_item
 201 mechanism)
 202
 203 =item *
 204
 205 Should be useable with hand scanners or similar alternative keyboard devices
 206
 207 =item *
 208
 209 Should not require a feedback/check loop in the common case
 210
 211 =item *
 212
 213 Should not be constrained to exact matches
 214
 215 =back
 216
 217 The implementation consists of the following parts which will be referenced later:
 218
 219 =over 4
 220
 221 =item 1
 222
 223 A hidden input (id input), used to hold the id of the selected part. The only
 224 input that gets submitted
 225
 226 =item 2
 227
 228 An input (dummy input) containing a description of the currently selected part,
 229 also used by the user to search for parts
 230
 231 =item 3
 232
 233 A jquery.autocomplete mechanism attached to the dummy field
 234
 235 =item 4
 236
 237 A popup layer for both feedback and input of additional data in case of
 238 ambiguity.
 239
 240 =item 5
 241
 242 An internal status of the part picker, indicating whether id input and dummy
 243 input are consistent. After leaving the dummy input the part picker must
 244 place itself in a consistent status.
 245
 246 =item 6
 247
 248 A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
 249
 250 =back
 251
 252 =head1 BUGS
 253
 254 None atm :)
 255
 256 =head1 AUTHOR
 257
 258 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 259
 260 =cut