kivitendo/SL/Presenter/Part.pm @ 7bc44f0f
| 2504ebe1 | Sven Schöling | package SL::Presenter::Part;
|
||
use strict;
|
||||
| 2477c498 | Moritz Bunkus | use SL::DB::Part;
|
||
| 2504ebe1 | Sven Schöling | use Exporter qw(import);
|
||
| f33995ff | Geoffrey Richardson | our @EXPORT = qw(part_picker part);
|
||
use Carp;
|
||||
sub part {
|
||||
my ($self, $part, %params) = @_;
|
||||
$params{display} ||= 'inline';
|
||||
croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/;
|
||||
my $text = join '', (
|
||||
$params{no_link} ? '' : '<a href="ic.pl?action=edit&id=' . $self->escape($part->id) . '">',
|
||||
$self->escape($part->partnumber),
|
||||
$params{no_link} ? '' : '</a>',
|
||||
);
|
||||
return $self->escaped_text($text);
|
||||
}
|
||||
| 2504ebe1 | Sven Schöling | |||
sub part_picker {
|
||||
my ($self, $name, $value, %params) = @_;
|
||||
| 20576aac | Sven Schöling | $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value;
|
||
| 9e278d06 | Moritz Bunkus | my $id = delete($params{id}) || $self->name_to_id($name);
|
||
| ee74ea82 | Sven Schöling | my $fat_set_item = delete $params{fat_set_item};
|
||
my @classes = $params{class} ? ($params{class}) : ();
|
||||
push @classes, 'part_autocomplete';
|
||||
push @classes, 'partpicker_fat_set_item' if $fat_set_item;
|
||||
| 2504ebe1 | Sven Schöling | |||
my $ret =
|
||||
| ee74ea82 | Sven Schöling | $self->input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id) .
|
||
| df33875f | Moritz Bunkus | join('', map { $params{$_} ? $self->input_tag("", delete $params{$_}, id => "${id}_${_}", type => 'hidden') : '' } qw(column type unit convertible_unit)) .
|
||
| 880a2e9f | Moritz Bunkus | $self->input_tag("", (ref $value && $value->can('description')) ? $value->description : '', id => "${id}_name", %params);
|
||
| 2504ebe1 | Sven Schöling | |||
| b58bafbb | Sven Schöling | $::request->layout->add_javascripts('autocomplete_part.js');
|
||
| 3ac83c61 | Moritz Bunkus | $::request->presenter->need_reinit_widgets($id);
|
||
| 2504ebe1 | Sven Schöling | $self->html_tag('span', $ret, class => 'part_picker');
|
||
}
|
||||
1;
|
||||
| 9aaadfdc | Sven Schöling | |||
__END__
|
||||
=encoding utf-8
|
||||
=head1 NAME
|
||||
| f33995ff | Geoffrey Richardson | SL::Presenter::Part - Part related presenter stuff
|
||
| 9aaadfdc | Sven Schöling | |||
=head1 SYNOPSIS
|
||||
| f33995ff | Geoffrey Richardson | # Create an html link for editing/opening a part/service/assembly
|
||
my $object = my $object = SL::DB::Manager::Part->get_first;
|
||||
my $html = SL::Presenter->get->part($object, display => 'inline');
|
||||
see also L<SL::Presenter>
|
||||
| 9aaadfdc | Sven Schöling | |||
=head1 DESCRIPTION
|
||||
see L<SL::Presenter>
|
||||
=head1 FUNCTIONS
|
||||
| f33995ff | Geoffrey Richardson | =over 2
|
||
=item C<part, $object, %params>
|
||||
Returns a rendered version (actually an instance of
|
||||
L<SL::Presenter::EscapedText>) of the part object C<$object>
|
||||
C<%params> can include:
|
||||
| 9aaadfdc | Sven Schöling | =over 4
|
||
| f33995ff | Geoffrey Richardson | =item * display
|
||
Either C<inline> (the default) or C<table-cell>. At the moment both
|
||||
representations are identical and produce the part's name linked
|
||||
to the corresponding 'edit' action.
|
||||
=back
|
||||
| 2f6a11fb | Bernd Bleßmann | =back
|
||
| f33995ff | Geoffrey Richardson | |||
=over 2
|
||||
| 9e278d06 | Moritz Bunkus | =item C<part_picker $name, $value, %params>
|
||
| 9aaadfdc | Sven Schöling | |||
| 9e278d06 | Moritz Bunkus | All-in-one picker widget for parts. The name will be both id and name
|
||
of the resulting hidden C<id> input field (but the ID can be
|
||||
overwritten with C<$params{id}>).
|
||||
| 9aaadfdc | Sven Schöling | |||
| 9e278d06 | Moritz Bunkus | An additional dummy input will be generated which is used to find
|
||
| 976b1ddf | Geoffrey Richardson | parts. For a detailed description of its behaviour, see section
|
||
| 9e278d06 | Moritz Bunkus | C<PART PICKER SPECIFICATION>.
|
||
| 9aaadfdc | Sven Schöling | |||
| 9e278d06 | Moritz Bunkus | C<$value> can be a parts id or a C<Rose::DB:Object> instance.
|
||
| 9aaadfdc | Sven Schöling | |||
| 9e278d06 | Moritz Bunkus | If C<%params> contains C<type> only parts of this type will be used
|
||
for autocompletion. You may comma separate multiple types as in
|
||||
C<part,assembly>.
|
||||
| 9aaadfdc | Sven Schöling | |||
| 880a2e9f | Moritz Bunkus | If C<%params> contains C<unit> only parts with this unit will be used
|
||
for autocompletion. You may comma separate multiple units as in
|
||||
C<h,min>.
|
||||
| 9aaadfdc | Sven Schöling | |||
| df33875f | Moritz Bunkus | If C<%params> contains C<convertible_unit> only parts with a unit
|
||
that's convertible to unit will be used for autocompletion.
|
||||
| 9aaadfdc | Sven Schöling | |||
| 976b1ddf | Geoffrey Richardson | Obsolete parts will by default not be displayed for selection. However they are
|
||
| 58e12eca | Sven Schöling | accepted as default values and can persist during updates. As with other
|
||
| 5c48c74b | Sven Schöling | selectors though, they are not selectable once overridden.
|
||
| 58e12eca | Sven Schöling | |||
| c89986ac | Sven Schöling | C<part_picker> will register it's javascript for inclusion in the next header
|
||
rendering. If you write a standard controller that only call C<render> once, it
|
||||
will just work. In case the header is generated in a different render call
|
||||
(multiple blocks, ajax, old C<bin/moilla> style controllers) you need to
|
||||
include C<js/autocomplete_part.js> yourself.
|
||||
| 9aaadfdc | Sven Schöling | |||
=back
|
||||
| 81e4602d | Sven Schöling | =head1 PART PICKER SPECIFICATION
|
||
The following list of design goals were applied:
|
||||
=over 4
|
||||
=item *
|
||||
Parts should not be perceived by the user as distinct inputs of partnumber and
|
||||
description but as a single object
|
||||
=item *
|
||||
Easy to use without documentation for novice users
|
||||
=item *
|
||||
Fast to use with keyboard for experienced users
|
||||
=item *
|
||||
Possible to use without any keyboard interaction for mouse (or touchscreen)
|
||||
users
|
||||
=item *
|
||||
Must not leave the current page in event of ambiguity (cf. current select_item
|
||||
mechanism)
|
||||
=item *
|
||||
Should be useable with hand scanners or similar alternative keyboard devices
|
||||
=item *
|
||||
Should not require a feedback/check loop in the common case
|
||||
=item *
|
||||
| 976b1ddf | Geoffrey Richardson | Should not be constrained to exact matches
|
||
| 81e4602d | Sven Schöling | |||
=back
|
||||
The implementation consists of the following parts which will be referenced later:
|
||||
=over 4
|
||||
=item 1
|
||||
A hidden input (id input), used to hold the id of the selected part. The only
|
||||
input that gets submitted
|
||||
=item 2
|
||||
An input (dummy input) containing a description of the currently selected part,
|
||||
also used by the user to search for parts
|
||||
=item 3
|
||||
A jquery.autocomplete mechanism attached to the dummy field
|
||||
=item 4
|
||||
A popup layer for both feedback and input of additional data in case of
|
||||
ambiguity.
|
||||
=item 5
|
||||
| 976b1ddf | Geoffrey Richardson | An internal status of the part picker, indicating whether id input and dummy
|
||
| 81e4602d | Sven Schöling | input are consistent. After leaving the dummy input the part picker must
|
||
place itself in a consistent status.
|
||||
=item 6
|
||||
A clickable icon (popup trigger) attached to the dummy input, which triggers the popup layer.
|
||||
=back
|
||||
| 9aaadfdc | Sven Schöling | =head1 BUGS
|
||
| 686cf1ec | Sven Schöling | None atm :)
|
||
| 9aaadfdc | Sven Schöling | |||
=head1 AUTHOR
|
||||
Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
|
||||
=cut
|