X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FPresenter%2FPart.pm;h=4f2105caa172fcd247068318778689d7a6771a63;hb=6660259a9e3f781210b3eedb933c55da27116c0b;hp=e0f670c624d535257d4e189095ab3bd31a6d6720;hpb=426a5bf3c8b6a5cd2509699ebace0d24e614f2b7;p=kivitendo-erp.git diff --git a/SL/Presenter/Part.pm b/SL/Presenter/Part.pm index e0f670c62..4f2105caa 100644 --- a/SL/Presenter/Part.pm +++ b/SL/Presenter/Part.pm @@ -5,53 +5,64 @@ use strict; use SL::DB::Part; use SL::DB::PartClassification; use SL::Locale::String qw(t8); +use SL::Presenter::EscapedText qw(escape is_escaped); +use SL::Presenter::Tag qw(input_tag html_tag name_to_id select_tag); use Exporter qw(import); -our @EXPORT = qw(part_picker part select_classification classification_abbreviation type_abbreviation separate_abbreviation typeclass_abbreviation); +our @EXPORT_OK = qw( + part_picker part select_classification classification_abbreviation + type_abbreviation separate_abbreviation typeclass_abbreviation +); +our %EXPORT_TAGS = (ALL => \@EXPORT_OK); use Carp; sub part { - my ($self, $part, %params) = @_; + my ($part, %params) = @_; $params{display} ||= 'inline'; croak "Unknown display type '$params{display}'" unless $params{display} =~ m/^(?:inline|table-cell)$/; my $text = join '', ( - $params{no_link} ? '' : '', - $self->escape($part->partnumber), + $params{no_link} ? '' : '', + escape($part->partnumber), $params{no_link} ? '' : '', ); - return $self->escaped_text($text); + + is_escaped($text); } sub part_picker { - my ($self, $name, $value, %params) = @_; + my ($name, $value, %params) = @_; $value = SL::DB::Manager::Part->find_by(id => $value) if $value && !ref $value; - my $id = $params{id} || $self->name_to_id($name); + my $id = $params{id} || name_to_id($name); my @classes = $params{class} ? ($params{class}) : (); push @classes, 'part_autocomplete'; my $ret = - $self->input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id, + input_tag($name, (ref $value && $value->can('id') ? $value->id : ''), class => "@classes", type => 'hidden', id => $id, 'data-part-picker-data' => JSON::to_json(\%params), ) . - $self->input_tag("", ref $value ? $value->displayable_name : '', id => "${id}_name", %params); + input_tag("", ref $value ? $value->displayable_name : '', id => "${id}_name", %params); $::request->layout->add_javascripts('kivi.Part.js'); $::request->presenter->need_reinit_widgets($id); - $self->html_tag('span', $ret, class => 'part_picker'); + html_tag('span', $ret, class => 'part_picker'); } +sub picker { goto &part_picker } + # # shortcut for article type # sub type_abbreviation { - my ($self, $part_type) = @_; + my ($part_type) = @_; + + return '' if !$part_type; return $::locale->text('Assembly (typeabbreviation)') if $part_type eq 'assembly'; return $::locale->text('Part (typeabbreviation)') if $part_type eq 'part'; return $::locale->text('Assortment (typeabbreviation)') if $part_type eq 'assortment'; @@ -77,23 +88,29 @@ sub type_abbreviation { # shortcut for article type # sub classification_abbreviation { - my ($self, $id) = @_; + my ($id) = @_; + + return '' if !$id; + SL::DB::Manager::PartClassification->cache_all(); my $obj = SL::DB::PartClassification->load_cached($id); $obj && $obj->abbreviation ? t8($obj->abbreviation) : ''; } sub typeclass_abbreviation { - my ($self, $part) = @_; + my ($part) = @_; return '' if !$part || !$part->isa('SL::DB::Part'); - return $self->type_abbreviation($part->part_type).$self->classification_abbreviation($part->classification_id); + return type_abbreviation($part->part_type) . classification_abbreviation($part->classification_id); } # # shortcut for article type # sub separate_abbreviation { - my ($self, $id) = @_; + my ($id) = @_; + + return '' if !$id; + SL::DB::Manager::PartClassification->cache_all(); my $obj = SL::DB::PartClassification->load_cached($id); $obj && $obj->abbreviation && $obj->report_separate ? t8($obj->abbreviation) : ''; @@ -103,12 +120,16 @@ sub separate_abbreviation { # generate selection tag # sub select_classification { - my ($self, $name, %attributes) = @_; + my ($name, %attributes) = @_; + $attributes{value_key} = 'id'; $attributes{title_key} = 'description'; - my $collection = SL::DB::Manager::PartClassification->get_all_sorted(); + + my $classification_type_filter = delete $attributes{type} // []; + + my $collection = SL::DB::Manager::PartClassification->get_all_sorted( where => $classification_type_filter ); $_->description($::locale->text($_->description)) for @{ $collection }; - return $self->select_tag( $name, $collection, %attributes ); + select_tag( $name, $collection, %attributes ); } 1; @@ -124,7 +145,7 @@ SL::Presenter::Part - Part related presenter stuff =head1 SYNOPSIS # Create an html link for editing/opening a part/service/assembly - my $object = my $object = SL::DB::Manager::Part->get_first; + my $object = SL::DB::Manager::Part->get_first; my $html = SL::Presenter->get->part($object, display => 'inline'); see also L @@ -168,7 +189,7 @@ Returns the shortcut of the classification =item C -Returns the shortcut of the classification if the classifiaction has the separate flag set. +Returns the shortcut of the classification if the classification has the separate flag set. =back @@ -176,7 +197,7 @@ Returns the shortcut of the classification if the classifiaction has the separat =item C -Returns a HTML Select Tag with all available Classifications +Returns an HTML select tag with all available classifications. C<%params> can include: @@ -184,7 +205,7 @@ C<%params> can include: =item * default -The Id of the selected item . +The id of the selected item. =back @@ -220,11 +241,48 @@ accepted as default values and can persist during updates. As with other selectors though, they are not selectable once overridden. C will register it's javascript for inclusion in the next header -rendering. If you write a standard controller that only call C once, it -will just work. In case the header is generated in a different render call +rendering. If you write a standard controller that only calls C once, it +will just work. In case the header is generated in a different render call (multiple blocks, ajax, old C style controllers) you need to include C yourself. +On pressing the picker will try to commit the current selection, +resulting in one of the following events, whose corresponding callbacks can be +set in C: + +=over 4 + +=item * C + +If exactly one element matches the input, the internal id will be set to this +id, the internal state will be set to C and the C event on the +picker will be fired. Additionally, if C contains C a +special event C will be fired which is guaranteed to +contain a complete JSON representation of the part. + +After that the action C will be executed, which defaults to +clicking a button with id C for backward compatibility reasons. + +=item * C + +If more than one element matches the input, the internal state will be set to +undefined. + +After that the action C will be executed, which defaults to +opening a popup dialog for graphical interaction. If C contains +C an alternative popup will be opened, allowing multiple items to be +selected. Note however that this requires an additional callback +C to work. + +=item * C + +If no element matches the input, the internal state will be set to undefined. + +If an action for C exists, it will be called with the picker +object and current term. The caller can then implement creation of new parts. + +=back + =back =head1 PART PICKER SPECIFICATION @@ -268,6 +326,14 @@ Should not require a feedback/check loop in the common case Should not be constrained to exact matches +=item * + +Must be atomic + +=item * + +Action should be overridable + =back The implementation consists of the following parts which will be referenced later: