Perl
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib/Data/Page
t
xt
.cvsignore
.gitignore
.shipit
Changes
MANIFEST
MANIFEST.SKIP
Makefile.PL
README

README

NAME
       Data::Page::FlickrLike − Generates flickr−like navigation links

SYNOPSIS
	   use Data::Page;
	   use Data::Page::FlickrLike;

	   my $page = Data::Page−>new();
	   $page−>total_entries($total_entries);
	   $page−>entries_per_page($entries_per_page);
	   $page−>current_page($current_page);

	   print join (" ",
		   map { $_ == 0
		     ? q{<span>...</span>}
		     : qq{<a href="/page/$_">$_</a>}
		   } $page−>navigations);

	   # 1*2 3 4 5 6 7 ... 76 77
	   # 1 2 ... 10 11 12 13*14 15 16 ... 76 77
	   # 1 2 ... 71 72 73 74 75 76 77*
	   # Note: * means the current page

DESCRIPTION
       Data::Page::FlickrLike is an extension to Data::Page to generate
       flickr‐like navigation links.

METHODS
       navigations (Data::Page)
	   This method gets an array reference consists of the number of
	   pages.

	      $nav = $page−>navigations

	   It calculates: how may numbers should be displayed from the first
	   page, how many numbers should be displayed form the last page,
	   whether or not there’s a big enough gap between the first page and
	   current page to put an ellipsis and more.  As the name of this
	   modules says, the array ref should make it easy to generate a
	   "Flickr‐Like" navigation.

	   It uses "0" for an ellipsis between two sets of page numbers.  For
	   example, if you have enough amount of items, navigations() returns
	   like this:

	     [ 1, 2, 3, 4, 5, 6, 7, 0, 76, 77 ]

	   So, you need to put an exception to display an ellipsis(...) like
	   this.

	       for my $num ($page−>navigations) {
		   if ($num == 0 ) {
		       print "...";
		   } else {
		       print qq{<a href="/page/$_">$_</a>};
		   }
	       }

CONFIGURATION VARIABLES
       By default, navigation() generates an array reference to create
       pagination links exactly as the same as Flickr.com does. But if you do
       not like this behavior, you can tweak these configuration variables.

       $Data::Page::FlickrLike::InnerWindow or
       $page−>navigations({inner_window => $val})
	   Customises the number of links displayed at side of the current
	   page.

       $Data::Page::FlickrLike::OuterWindow or
       $page−>navigations({outer_window => $val})
	   Customises the number of links displayed at the start and end of
	   the page links.

       $Data::Page::FlickrLike::MinLength or $page−>navigations({min_length =>
       $val})
	   Customises the minimum number of the links displayed when the
	   current page at the first or last page.

       $Data::Page::FlickrLike::GlueLength or $page−>navigations({glue_length
       => $val})
	   Customises the minimum number of the links at the either side of
	   the current page and the links at the first and last. For example,
	   these "3g" and "4g" are displayed because of the glue length (= 2).

	    1	2   3	4   5	6*  7	8   9	  ...	21   22
	    1	2   3g	4   5	6   7*	8   9	10     ...   21   22
	    1	2   3g	4g  5	6   7	8*  9	10   11     ...  21   22
	    1	2     ...   5	6   7	8   9*	10   11   12	 ...   21   22

	    (* means a number of the current page)

AUTHOR
       Masayoshi Sekimura <sekimura@cpan.org>

LICENSE
       This library is free software; you can redistribute it and/or modify it
       under the same terms as Perl itself.

SEE ALSO
       Data::Page, Data::Page::Navigation, http://flickr.com/