Whitespace

[kivitendo-erp.git] / SL / Presenter / Part.pm

diff --git a/SL/Presenter/Part.pm b/SL/Presenter/Part.pm
index e0f670c..8f13aee 100644 (file)
--- a/SL/Presenter/Part.pm
+++ b/SL/Presenter/Part.pm
@@ -104,9 +104,13 @@ sub separate_abbreviation {
 #
 sub select_classification {
   my ($self, $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 );
 }
@@ -124,7 +128,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<SL::Presenter>
@@ -168,7 +172,7 @@ Returns the shortcut of the classification
 
 =item C<separate_abbreviation $classification_id>
 
-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 +180,7 @@ Returns the shortcut of the classification if the classifiaction has the separat
 
 =item C<select_classification $name,%params>
 
-Returns a HTML Select Tag with all available Classifications
+Returns an HTML select tag with all available classifications.
 
 C<%params> can include:
 
@@ -184,7 +188,7 @@ C<%params> can include:
 
 =item * default
 
-The Id of the selected item .
+The id of the selected item.
 
 =back
 
@@ -220,11 +224,48 @@ accepted as default values and can persist during updates. As with other
 selectors though, they are not selectable once overridden.
 
 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
+rendering. If you write a standard controller that only calls C<render> once, it
+will just work. In case the header is generated in a different render call
 (multiple blocks, ajax, old C<bin/mozilla> style controllers) you need to
 include C<kivi.Part.js> yourself.
 
+On pressing <enter> the picker will try to commit the current selection,
+resulting in one of the following events, whose corresponding callbacks can be
+set in C<params.actions>:
+
+=over 4
+
+=item * C<commit_one>
+
+If exactly one element matches the input, the internal id will be set to this
+id, the internal state will be set to C<PICKED> and the C<change> event on the
+picker will be fired. Additionally, if C<params> contains C<fat_set_item> a
+special event C<set_item:PartPicker> will be fired which is guaranteed to
+contain a complete JSON representation of the part.
+
+After that the action C<commit_one> will be executed, which defaults to
+clicking a button with id C<update_button> for backward compatibility reasons.
+
+=item * C<commit_many>
+
+If more than one element matches the input, the internal state will be set to
+undefined.
+
+After that the action C<commit_one> will be executed, which defaults to
+opening a popup dialog for graphical interaction. If C<params> contains
+C<multiple> an alternative popup will be opened, allowing multiple items to be
+selected. Note however that this requires an additional callback
+C<set_multi_items> to work.
+
+=item * C<commit_none>
+
+If no element matches the input, the internal state will be set to undefined.
+
+If an action for C<commit_none> 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 +309,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: