Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811

[kivitendo-erp.git] / SL / Controller / Helper / GetModels / Paginated.pm

diff --git a/SL/Controller/Helper/GetModels/Paginated.pm b/SL/Controller/Helper/GetModels/Paginated.pm
index a632fc0..86b248c 100644 (file)
--- a/SL/Controller/Helper/GetModels/Paginated.pm
+++ b/SL/Controller/Helper/GetModels/Paginated.pm
@@ -32,8 +32,8 @@ sub read_params {
   my $source = $self->get_models->source;
 
   my $from_form = {
   my $source = $self->get_models->source;
 
   my $from_form = {

-    page            => $source->{ $self->form_params->[0] } || 1,
-    per_page        => $source->{ $self->form_params->[1] } * 1,
+    page            =>  $source->{ $self->form_params->[0] } || 1,
+    per_page        => ($source->{ $self->form_params->[1] } // 0) * 1,

   };
 
 #  my $priv              = _priv($self);
   };
 
 #  my $priv              = _priv($self);


@@ -50,23 +50,24 @@ sub read_params {
 
 sub finalize {
   my ($self, %args)   = @_;
 
 sub finalize {
   my ($self, %args)   = @_;

-#  return () unless $self->is_enabled;
-  my %paginate_params = $self->read_params;

 
 

-  # try to use Filtered if available and nothing else is configured, but don't
-  # blow up if the controller does not use Filtered
-  my %paginate_args     = ref($self->paginate_args) eq 'CODE'       ? %{ $self->paginate_args->($self) }
-                        :     $self->paginate_args  eq '__FILTER__'
-                           && $self->get_models->filtered ? $self->get_models->filtered->read_params
-                        :     $self->paginate_args  ne '__FILTER__' ? do { my $sub = $self->paginate_args; %{ $self->get_models->controller->$sub() } }
-                        :                                               ();
+  if ($self->is_enabled) {
+    my %paginate_params = $self->read_params;

 
 

-  %args = $self->merge_args(\%args, \%paginate_args);
+    # try to use Filtered if available and nothing else is configured, but don't
+    # blow up if the controller does not use Filtered
+    my %paginate_args     = ref($self->paginate_args) eq 'CODE'       ? %{ $self->paginate_args->($self) }
+                          :     $self->paginate_args  ne '__FILTER__' ? do { my $sub = $self->paginate_args; %{ $self->get_models->controller->$sub() } }
+                          :                                               ();

 
 

-  my $calculated_params = $self->get_models->manager->paginate(%paginate_params, args => \%args);
+    %args = $self->merge_args(\%args, \%paginate_args);
+
+    my $calculated_params = $self->get_models->manager->paginate(%paginate_params, args => \%args);
+
+    $self->calculated_params($calculated_params);
+  }

 
   $self->paginated_args(\%args);
 
   $self->paginated_args(\%args);

-  $self->calculated_params($calculated_params);

 
   return %args;
 }
 
   return %args;
 }


@@ -119,59 +120,30 @@ of paginating lists of database models in a controller
 
 In a controller:
 
 
 In a controller:
 

-  use SL::Controller::Helper::GetModels;
-  use SL::Controller::Helper::Paginated;
-
-  __PACKAGE__->make_paginated(
-    MODEL       => 'BackgroundJobHistory',
-    ONLY        => [ qw(list) ],
-    FORM_PARAMS => [ qw(page per_page) ],
+  SL::Controller::Helper::GetModels->new(
+    ..
+    paginated => {
+      form_params => [ qw(page per_page) ],
+      per_page    => 20,
+    }

   );
 
   );
 

-  sub action_list {
-    my ($self) = @_;
-
-    my $paginated_models = $self->get_models;
-    $self->render('controller/list', ENTRIES => $paginated_models);
-  }
-

 In said template:
 
 In said template:
 

-  [% USE L %]
-
-  <table>
-   <thead>
-    <tr>
-     ...
-    </tr>
-   </thead>
-
-   <tbody>
-    [% FOREACH entry = ENTRIES %]
-     <tr>
-      ...
-     </tr>
-    [% END %]
-   </tbody>
-  </table>
-

   [% L.paginate_controls %]
 
 =head1 OVERVIEW
 
   [% L.paginate_controls %]
 
 =head1 OVERVIEW
 

-This specialized helper module enables controllers to display a
-paginatable list of database models with as few lines as possible. It
-can also be combined trivially with the L<SL::Controller::Sorted>
-helper for sortable lists.
+This C<GetModels> plugin enables controllers to display a
+paginatable list of database models with as few lines as possible.

 
 For this to work the controller has to provide the information which
 
 For this to work the controller has to provide the information which

-indexes are eligible for paginateing etc. by a call to
-L<make_paginated> at compile time.
+indexes are eligible for paginateing etc. during C<GetModels> creation.

 
 The underlying functionality that enables the use of more than just
 the paginate helper is provided by the controller helper
 
 The underlying functionality that enables the use of more than just
 the paginate helper is provided by the controller helper

-C<GetModels>. See the documentation for L<SL::Controller::Sorted> for
-more information on it.
+C<GetModels>. See the documentation for L<SL::Controller::Helper::GetModels>
+for more information on it.

 
 A template can use the method C<paginate_controls> from the layout
 helper module C<L> which renders the links for navigation between the
 
 A template can use the method C<paginate_controls> from the layout
 helper module C<L> which renders the links for navigation between the


@@ -180,53 +152,18 @@ pages.
 This module requires that the Rose model managers use their C<Paginated>
 helper.
 
 This module requires that the Rose model managers use their C<Paginated>
 helper.
 

-The C<Paginated> helper hooks into the controller call to the action via
-a C<run_before> hook. This is done so that it can remember the paginate
-parameters that were used in the current view.
-
-=head1 PACKAGE FUNCTIONS
-
-=over 4
-
-=item C<make_paginated %paginate_spec>
-
-This function must be called by a controller at compile time. It is
-uesd to set the various parameters required for this helper to do its
-magic.
-
-The hash C<%paginate_spec> can include the following parameters:
+=head1 OPTIONS

 
 =over 4
 
 
 =over 4
 

-=item * C<MODEL>
-
-Optional. A string: the name of the Rose database model that is used
-as a default in certain cases. If this parameter is missing then it is
-derived from the controller's package (e.g. for the controller
-C<SL::Controller::BackgroundJobHistory> the C<MODEL> would default to
-C<BackgroundJobHistory>).
-
-=item * C<PAGINATE_ARGS>
-
-Optional. Either a code reference or the name of function to be called
-on the controller importing this helper.
-
-If this funciton is given then the paginate helper calls it whenever
-it has to count the total number of models for calculating the number
-of pages to display. The function must return a hash reference with
-elements suitable for passing to a Rose model manager's C<get_all>
-function.
-
-This can be used e.g. when filtering is used.
-
-=item * C<PER_PAGE>
+=item * C<per_page>

 
 

-Optional. An integer: the number of models to return per page.
+Optional. The number of models to return per page.

 
 Defaults to the underlying database model's default number of models
 per page.
 
 
 Defaults to the underlying database model's default number of models
 per page.
 

-=item * C<FORM_PARAMS>
+=item * C<form_params>

 
 Optional. An array reference with exactly two strings that name the
 indexes in C<$::form> in which the current page's number (the first
 
 Optional. An array reference with exactly two strings that name the
 indexes in C<$::form> in which the current page's number (the first


@@ -235,19 +172,11 @@ element in the array) are stored.
 
 Defaults to the values C<page> and C<per_page> if missing.
 
 
 Defaults to the values C<page> and C<per_page> if missing.
 

-=item * C<ONLY>
-
-Optional. An array reference containing a list of action names for
-which the paginate parameters should be saved. If missing or empty then
-all actions invoked on the controller are monitored.
-
-=back
-

 =back
 
 =head1 INSTANCE FUNCTIONS
 
 =back
 
 =head1 INSTANCE FUNCTIONS
 

-These functions are called on a controller instance.
+These functions are called on a C<GetModels> instance and delegated here.

 
 =over 4
 
 
 =over 4
 


@@ -282,24 +211,26 @@ displayed).
 
 =item C<get_current_paginate_params>
 
 
 =item C<get_current_paginate_params>
 

-Returns a hash reference to the paginate spec structure given in the call
-to L<make_paginated> after normalization (hash reference construction,
+Returns a hash reference to the paginate spec structure given in the
+configuration after normalization (hash reference construction,

 applying default parameters etc).
 
 applying default parameters etc).
 

-=item C<disable_pagination>
-
-Disable pagination for the duration of the current action. Can be used
-when using the attribute C<ONLY> to L<make_paginated> does not
-cover all cases.
-

 =back
 
 =head1 BUGS
 
 =back
 
 =head1 BUGS
 

-Nothing here yet.
+C<common_pages> generates an array with an entry for every page, which gets
+slow if there are a lot of entries. Current observation holds that up to about
+1000 pages there is no noticable slowdown, but at about 10000 it gets
+noticable. At 100k-500k pages it's takes way too long and should be remodelled.
+
+This case currently only applies for databases with very large amounts of parts
+that get paginated, but BackgroundJobHistory can also accumulate.

 
 =head1 AUTHOR
 
 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 
 
 =head1 AUTHOR
 
 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
 

+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
+

 =cut
 =cut