Attachment #116515 for bug #23763

View | Details | Raw Unified | Return to bug 23763
Collapse All | Expand All




use Modern::Perl;
use C4::Context;
use C4::Biblio qw//;
use POSIX qw(ceil floor);

sub new {
    my $engine = C4::Context->preference("SearchEngine") // 'Zebra';

    return $record->subfield( $biblionumbertagfield, $biblionumbertagsubfield );
}

=head2 pagination_bar

my ( $PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
    $previous_page_offset, $next_page_offset, $last_page_offset ) = Koha::SearchEngine::Search->pagination_bar(
    {
        hits              => $hits,
        max_result_window => $max_result_window,
        results_per_page  => $results_per_page,
        offset            => $offset,
        sort_by           => \@sort_by
    }
  );

Returns the variables needed for the page-nubers.inc to build search results

=cut

sub pagination_bar {
    my ( $self, $params ) = @_;
    my $hits             = $params->{hits};
    my $results_per_page = $params->{results_per_page};
    my $offset           = $params->{offset};
    my $sort_by          = $params->{sort_by};
    my @page_numbers;
    my $max_result_window = $params->{max_result_window};
    my $hits_to_paginate =
      ( $max_result_window && $max_result_window < $hits )
      ? $max_result_window
      : $hits;

    # total number of pages there will be
    my $pages            = ceil( $hits_to_paginate / $results_per_page );
    my $last_page_offset = ( $pages - 1 ) * $results_per_page;

    # default page number
    my $current_page_number = 1;
    $current_page_number = ( $offset / $results_per_page + 1 ) if $offset;
    my $previous_page_offset;
    if ( $offset >= $results_per_page ) {
        $previous_page_offset = $offset - $results_per_page;
    }
    my $next_page_offset = $offset + $results_per_page;

    # If we're within the first 10 pages, keep it simple
    if ( $current_page_number < 10 ) {

        # just show the first 10 pages
        # Loop through the pages
        my $pages_to_show = 10;
        $pages_to_show = $pages if $pages < 10;
        for ( my $i = 1 ; $i <= $pages_to_show ; $i++ ) {

            # the offset for this page
            my $this_offset =
              ( ( $i * $results_per_page ) - $results_per_page );

            # the page number for this page
            my $this_page_number = $i;

            # put it in the array
            push @page_numbers, {
                offset => $this_offset,
                pg     => $this_page_number,

                # it should only be highlighted if it's the current page
                highlight => $this_page_number == $current_page_number,
                sort_by   => join ' ',
                @$sort_by
            };
        }
    }

    # now, show up to twenty pages, with the current one smack in the middle
    # near the end of search results we will show 10 below and as many remaining above
    else {
        for (
            my $i = $current_page_number ;
            $i <= ( $current_page_number + 19 ) ;
            $i++
          )
        {
            my $this_offset =
              ( ( ( $i - 9 ) * $results_per_page ) - $results_per_page );
            my $this_page_number = $i - 9;
            if ( $this_page_number <= $pages ) {
                push @page_numbers,
                  {
                    offset    => $this_offset,
                    pg        => $this_page_number,
                    highlight => $this_page_number == $current_page_number,
                    sort_by   => join ' ',
                    @$sort_by
                  };
            }
        }
    }

    return ( \@page_numbers, $hits_to_paginate, $pages, $current_page_number,
        $previous_page_offset, $next_page_offset, $last_page_offset );

}

1;




#!/usr/bin/perl
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;

use Test::More tests => 5;
use Test::Exception;

use t::lib::Mocks;

use Test::MockModule;

use MARC::Record;
use Try::Tiny;

use Koha::SearchEngine::Search;

subtest "pagination_bar tests" => sub {
    plan tests => 14;

    my @sort_by = ('relevance_dsc');

    my ( $PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
        $previous_page_offset, $next_page_offset, $last_page_offset )
      = Koha::SearchEngine::Search->pagination_bar(
        {
            hits              => 500,
            max_result_window => 1000,
            results_per_page  => 20,
            offset            => 160,
            sort_by           => \@sort_by
        }
      );
    is( $hits_to_paginate, 500,
        "We paginate all hits if less than max_result_window" );
    is( $pages, 25, "We have hits/hits_to_paginate pages" );
    is( $current_page_number, 9,
        "We calculate current page by offset/results_per_page plus 1" );
    is( $previous_page_offset, 140,
        "Previous page is current offset minus reults per page" );
    is( $next_page_offset, 180,
        "Next page is current offset plus reults per page" );
    is( $last_page_offset, 480,
        "Last page is pages minus 1 times reults per page" );
    is( @$PAGE_NUMBERS, 10, "If on first ten pages we only show 10 pages" );

    (
        $PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
        $previous_page_offset, $next_page_offset, $last_page_offset
      )
      = Koha::SearchEngine::Search->pagination_bar(
        {
            hits              => 500,
            max_result_window => 480,
            results_per_page  => 20,
            offset            => 240,
            sort_by           => \@sort_by
        }
      );
    is( $hits_to_paginate, 480,
        "We paginate all hits if less than max_result_window" );
    is( $pages, 24, "We have hits/hits_to_paginate pages" );
    is( $current_page_number, 13,
        "We calculate current page by offset/results_per_page plus 1" );
    is( $previous_page_offset, 220,
        "Previous page is current offset minus reults per page" );
    is( $next_page_offset, 260,
        "Next page is current offset plus reults per page" );
    is( $last_page_offset, 460,
        "Last page is pages minus 1 times reults per page" );
    is( @$PAGE_NUMBERS, 20, "If past first ten pages we show 20 pages" );

};

Return to bug 23763

Lines 46-51 Creates a new C<Search> of whatever the relevant type is. Link Here

(-)a/Koha/SearchEngine/Search.pm (+103 lines)
46	use Modern::Perl;	46	use Modern::Perl;
47	use C4::Context;	47	use C4::Context;
48	use C4::Biblio qw//;	48	use C4::Biblio qw//;
		49	use POSIX qw(ceil floor);
49		50
50	sub new {	51	sub new {
51	my $engine = C4::Context->preference("SearchEngine") // 'Zebra';	52	my $engine = C4::Context->preference("SearchEngine") // 'Zebra';
Lines 76-79 sub extract_biblionumber { Link Here
76	return $record->subfield( $biblionumbertagfield, $biblionumbertagsubfield );	77	return $record->subfield( $biblionumbertagfield, $biblionumbertagsubfield );
77	}	78	}
78		79
		80	=head2 pagination_bar
		81
		82	my ( $PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
		83	$previous_page_offset, $next_page_offset, $last_page_offset ) = Koha::SearchEngine::Search->pagination_bar(
		84	{
		85	hits => $hits,
		86	max_result_window => $max_result_window,
		87	results_per_page => $results_per_page,
		88	offset => $offset,
		89	sort_by => \@sort_by
		90	}
		91	);
		92
		93	Returns the variables needed for the page-nubers.inc to build search results
		94
		95	=cut
		96
		97	sub pagination_bar {
		98	my ( $self, $params ) = @_;
		99	my $hits = $params->{hits};
		100	my $results_per_page = $params->{results_per_page};
		101	my $offset = $params->{offset};
		102	my $sort_by = $params->{sort_by};
		103	my @page_numbers;
		104	my $max_result_window = $params->{max_result_window};
		105	my $hits_to_paginate =
		106	( $max_result_window && $max_result_window < $hits )
		107	? $max_result_window
		108	: $hits;
		109
		110	# total number of pages there will be
		111	my $pages = ceil( $hits_to_paginate / $results_per_page );
		112	my $last_page_offset = ( $pages - 1 ) * $results_per_page;
		113
		114	# default page number
		115	my $current_page_number = 1;
		116	$current_page_number = ( $offset / $results_per_page + 1 ) if $offset;
		117	my $previous_page_offset;
		118	if ( $offset >= $results_per_page ) {
		119	$previous_page_offset = $offset - $results_per_page;
		120	}
		121	my $next_page_offset = $offset + $results_per_page;
		122
		123	# If we're within the first 10 pages, keep it simple
		124	if ( $current_page_number < 10 ) {
		125
		126	# just show the first 10 pages
		127	# Loop through the pages
		128	my $pages_to_show = 10;
		129	$pages_to_show = $pages if $pages < 10;
		130	for ( my $i = 1 ; $i <= $pages_to_show ; $i++ ) {
		131
		132	# the offset for this page
		133	my $this_offset =
		134	( ( $i * $results_per_page ) - $results_per_page );
		135
		136	# the page number for this page
		137	my $this_page_number = $i;
		138
		139	# put it in the array
		140	push @page_numbers, {
		141	offset => $this_offset,
		142	pg => $this_page_number,
		143
144	# it should only be highlighted if it's the current page
145	highlight => $this_page_number == $current_page_number,
146	sort_by => join ' ',
147	@$sort_by
148	};
149	}
150	}
151
152	# now, show up to twenty pages, with the current one smack in the middle
153	# near the end of search results we will show 10 below and as many remaining above
154	else {
155	for (
156	my $i = $current_page_number ;
157	$i <= ( $current_page_number + 19 ) ;
158	$i++
159	)
160	{
161	my $this_offset =
162	( ( ( $i - 9 ) * $results_per_page ) - $results_per_page );
163	my $this_page_number = $i - 9;
164	if ( $this_page_number <= $pages ) {
165	push @page_numbers,
166	{
167	offset => $this_offset,
168	pg => $this_page_number,
169	highlight => $this_page_number == $current_page_number,
170	sort_by => join ' ',
171	@$sort_by
172	};
173	}
174	}
175	}
176
177	return ( \@page_numbers, $hits_to_paginate, $pages, $current_page_number,
178	$previous_page_offset, $next_page_offset, $last_page_offset );
179
180	}
181
79	1;	182	1;

Line 0 Link Here

(-)a/t/Koha/SearchEngine/Search.t (-1 / +87 lines)
0	-	1	#!/usr/bin/perl
		2	#
		3	# This file is part of Koha.
		4	#
		5	# Koha is free software; you can redistribute it and/or modify it
		6	# under the terms of the GNU General Public License as published by
		7	# the Free Software Foundation; either version 3 of the License, or
		8	# (at your option) any later version.
		9	#
		10	# Koha is distributed in the hope that it will be useful, but
		11	# WITHOUT ANY WARRANTY; without even the implied warranty of
		12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		13	# GNU General Public License for more details.
		14	#
		15	# You should have received a copy of the GNU General Public License
		16	# along with Koha; if not, see <http://www.gnu.org/licenses>.
		17
		18	use Modern::Perl;
		19
		20	use Test::More tests => 5;
		21	use Test::Exception;
		22
		23	use t::lib::Mocks;
		24
		25	use Test::MockModule;
		26
		27	use MARC::Record;
		28	use Try::Tiny;
		29
		30	use Koha::SearchEngine::Search;
		31
		32	subtest "pagination_bar tests" => sub {
		33	plan tests => 14;
		34
		35	my @sort_by = ('relevance_dsc');
		36
		37	my ( $PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
		38	$previous_page_offset, $next_page_offset, $last_page_offset )
		39	= Koha::SearchEngine::Search->pagination_bar(
		40	{
		41	hits => 500,
		42	max_result_window => 1000,
		43	results_per_page => 20,
		44	offset => 160,
		45	sort_by => \@sort_by
		46	}
		47	);
		48	is( $hits_to_paginate, 500,
		49	"We paginate all hits if less than max_result_window" );
		50	is( $pages, 25, "We have hits/hits_to_paginate pages" );
		51	is( $current_page_number, 9,
		52	"We calculate current page by offset/results_per_page plus 1" );
		53	is( $previous_page_offset, 140,
		54	"Previous page is current offset minus reults per page" );
		55	is( $next_page_offset, 180,
		56	"Next page is current offset plus reults per page" );
		57	is( $last_page_offset, 480,
		58	"Last page is pages minus 1 times reults per page" );
		59	is( @$PAGE_NUMBERS, 10, "If on first ten pages we only show 10 pages" );
		60
		61	(
		62	$PAGE_NUMBERS, $hits_to_paginate, $pages, $current_page_number,
		63	$previous_page_offset, $next_page_offset, $last_page_offset
		64	)
		65	= Koha::SearchEngine::Search->pagination_bar(
66	{
67	hits => 500,
68	max_result_window => 480,
69	results_per_page => 20,
70	offset => 240,
71	sort_by => \@sort_by
72	}
73	);
74	is( $hits_to_paginate, 480,
75	"We paginate all hits if less than max_result_window" );
76	is( $pages, 24, "We have hits/hits_to_paginate pages" );
77	is( $current_page_number, 13,
78	"We calculate current page by offset/results_per_page plus 1" );
79	is( $previous_page_offset, 220,
80	"Previous page is current offset minus reults per page" );
81	is( $next_page_offset, 260,
82	"Next page is current offset plus reults per page" );
83	is( $last_page_offset, 460,
84	"Last page is pages minus 1 times reults per page" );
85	is( @$PAGE_NUMBERS, 20, "If past first ten pages we show 20 pages" );
86
87	};