SL/Presenter/Part.pm

   1 package SL::Presenter::Part;
   2
   3 use strict;
   4
   5 use SL::DB::Part;
   6
   7 use Exporter qw(import);
   8 our @EXPORT = qw(part_picker part);
   9
  10 use Carp;
  11
  12 sub part {
  13   my ($self, $part, %params) = @_;
  14
  15   $params{display} ||= 'inline';
  16
  17   croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
  18
  19   my $text = join '', (
  20     $params{no_link} ? '' : '<a href="ic.pl?action=edit&id=' . $self->escape($part->id) . '">',
  21     $self->escape($part->partnumber),
  22     $params{no_link} ? '' : '</a>',
  23   );
  24   return $self->escaped_text($text);
  25 }
  26
  27 sub part_picker {
  28   my ($self, $name, $value, %params) = @_;
  29
  30   $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value;
  31   my $id = delete($params{id}) || $self->name_to_id($name);
  32   my $fat_set_item = delete $params{fat_set_item};
  33
  34   my @classes = $params{class} ? ($params{class}) : ();
  35   push @classes, 'part_autocomplete';
  36   push @classes, 'partpicker_fat_set_item' if $fat_set_item;
  37
  38   my $ret =
  39     $self->input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id) .
  40     join('', map { $params{$_} ? $self->input_tag("", delete $params{$_}, id => "${id}_${_}", type => 'hidden') : '' } qw(column type unit convertible_unit)) .
  41     $self->input_tag("", (ref $value && $value->can('description')) ? $value->description : '', id => "${id}_name", %params);
  42
  43   $::request->layout->add_javascripts('autocomplete_part.js');
  44   $::request->presenter->need_reinit_widgets($id);
  45
  46   $self->html_tag('span', $ret, class => 'part_picker');
  47 }
  48
  49 1;
  50
  51 __END__
  52
  53 =encoding utf-8
  54
  55 =head1 NAME
  56
  57 SL::Presenter::Part - Part related presenter stuff
  58
  59 =head1 SYNOPSIS
  60
  61   # Create an html link for editing/opening a part/service/assembly
  62   my $object = my $object = SL::DB::Manager::Part->get_first;
  63   my $html   = SL::Presenter->get->part($object, display => 'inline');
  64
  65 see also L<SL::Presenter>
  66
  67 =head1 DESCRIPTION
  68
  69 see L<SL::Presenter>
  70
  71 =head1 FUNCTIONS
  72
  73 =over 2
  74
  75 =item C<part, $object, %params>
  76
  77 Returns a rendered version (actually an instance of
  78 L<SL::Presenter::EscapedText>) of the part object C<$object>
  79
  80 C<%params> can include:
  81
  82 =over 4
  83
  84 =item * display
  85
  86 Either C<inline> (the default) or C<table-cell>. At the moment both
  87 representations are identical and produce the part's name linked
  88 to the corresponding 'edit' action.
  89
  90 =back
  91
  92 =back
  93
  94 =over 2
  95
  96 =item C<part_picker $name, $value, %params>
  97
  98 All-in-one picker widget for parts. The name will be both id and name
  99 of the resulting hidden C<id> input field (but the ID can be
 100 overwritten with C<$params{id}>).
 101
 102 An additional dummy input will be generated which is used to find
 103 parts. For a detailed description of it's behaviour, see section
 104 C<PART PICKER SPECIFICATION>.
 105
 106 C<$value> can be a parts id or a C<Rose::DB:Object> instance.
 107
 108 If C<%params> contains C<type> only parts of this type will be used
 109 for autocompletion. You may comma separate multiple types as in
 110 C<part,assembly>.
 111
 112 If C<%params> contains C<unit> only parts with this unit will be used
 113 for autocompletion. You may comma separate multiple units as in
 114 C<h,min>.
 115
 116 If C<%params> contains C<convertible_unit> only parts with a unit
 117 that's convertible to unit will be used for autocompletion.
 118
 119 Obsolete parts will by default not displayed for selection. However they are
 120 accepted as default values and can persist during updates. As with other
 121 selectors though, they are not selectable once overridden.
 122
 123 Currently you must include C<js/autocomplete_part.js> in old bin/mozilla-style
 124 controllers if C<<$form->header>> is called before the template. In all other
 125 cases, C<part_picker> will add the javascript for you.
 126
 127 =back
 128
 129 =head1 PART PICKER SPECIFICATION
 130
 131 The following list of design goals were applied:
 132
 133 =over 4
 134
 135 =item *
 136
 137 Parts should not be perceived by the user as distinct inputs of partnumber and
 138 description but as a single object
 139
 140 =item *
 141
 142 Easy to use without documentation for novice users
 143
 144 =item *
 145
 146 Fast to use with keyboard for experienced users
 147
 148 =item *
 149
 150 Possible to use without any keyboard interaction for mouse (or touchscreen)
 151 users
 152
 153 =item *
 154
 155 Must not leave the current page in event of ambiguity (cf. current select_item
 156 mechanism)
 157
 158 =item *
 159
 160 Should be useable with hand scanners or similar alternative keyboard devices
 161
 162 =item *
 163
 164 Should not require a feedback/check loop in the common case
 165
 166 =item *
 167
 168 Should not be constraint to exact matches
 169
 170 =back
 171
 172 The implementation consists of the following parts which will be referenced later:
 173
 174 =over 4
 175
 176 =item 1
 177
 178 A hidden input (id input), used to hold the id of the selected part. The only
 179 input that gets submitted
 180
 181 =item 2
 182
 183 An input (dummy input) containing a description of the currently selected part,
 184 also used by the user to search for parts
 185
 186 =item 3
 187
 188 A jquery.autocomplete mechanism attached to the dummy field
 189
 190 =item 4
 191
 192 A popup layer for both feedback and input of additional data in case of
 193 ambiguity.
 194
 195 =item 5
 196
 197 An internal status of the part picker, indicating wether id input and dummy
 198 input are consistent. After leaving the dummy input the part picker must
 199 place itself in a consistent status.
 200
 201 =item 6
 202
 203 A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
 204
 205 =back
 206
 207 =head1 BUGS
 208
 209 None atm :)
 210
 211 =head1 AUTHOR
 212
 213 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
 214
 215 =cut