class::dbi::plugin::retrieveall(3pm) [debian man page]

Class::DBI::Plugin::RetrieveAll(3pm)			User Contributed Perl Documentation		      Class::DBI::Plugin::RetrieveAll(3pm)

NAME

       Class::DBI::Plugin::RetrieveAll - more complex retrieve_all() for Class::DBI

SYNOPSIS

	       use base 'Class::DBI';
	       use Class::DBI::Plugin::RetrieveAll;

	       my @by_date = My::Class->retrieve_all_sorted_by("date");

	       # or

	       __PACKAGE__->retrieve_all_sort_field('date');

	       my @by_date = My::Class->retrieve_all;

DESCRIPTION

       This is a simple plugin to a Class::DBI subclass that allows for simple sorting of the results of a retrieve_all().

       There are two main ways to use this.

       Firstly, we create a new method 'retrieve_all_sorted_by' which takes an argument of how to sort.

       We also add a method for 'retrieve_all_sort_field' that sets a default field that any retrieve_all() will use for sorting.

METHODS

   retrieve_all_sorted_by
	       my @by_date = My::Class->retrieve_all_sorted_by("date");

       This method will be exported into the calling class, and allows for retrieving all the objects of the class, sorted by the given column.

       The argument given will be passed straight through to the database 'as is', and is not checked in any way, so an error here will usually in
       an error from the database, rather than Class::DBI itself.

       This makes it possible to pass more complex ORDER BY clauses through:

	       my @by_date = My::Class->retrieve_all_sorted_by("date DESC, reference_no");

   retrieve_all_sort_field
	 __PACKAGE__->retrieve_all_sort_field('date');

       This method changes the default retrieve_all() in the Class to be auto-sorted by the field given. Again this will be passed through
       directly, so you can have complex ORDER BY clauses.

AUTHOR

       Tony Bowden

BUGS and QUERIES
       Please direct all correspondence regarding this module to:
	 bug-Class-DBI-Plugin-RetrieveAll@rt.cpan.org

COPYRIGHT and LICENSE
       Copyright (C) 2004-2006 Kasei. All rights reserved.

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

perl v5.10.0							    2006-01-16				      Class::DBI::Plugin::RetrieveAll(3pm)

Class::DBI::Pager(3pm)					User Contributed Perl Documentation				    Class::DBI::Pager(3pm)

NAME

       Class::DBI::Pager - Pager utility for Class::DBI

SYNOPSIS

	 package CD;
	 use base qw(Class::DBI);
	 __PACKAGE__->set_db(...);

	 use Class::DBI::Pager;        # just use it

	 # then, in client code!
	 package main;

	 use CD;
	 my $pager = CD->pager(20, 1);	   # ($items_per_page, $current_page)
	 my @disks = $pager->retrieve_all;

DESCRIPTION

       Class::DBI::Pager is a plugin for Class::DBI, which glues Data::Page with Class::DBI. This module reduces your work a lot, for example when
       you have to do something like:

	 * retrieve objects from a database
	 * display objects with 20 items per page

       In addition, your work will be reduced more, when you use Template-Toolkit as your templating engine. See "EXAMPLE" for details.

EXAMPLE

	 # Controller: (MVC's C)
	 my $query    = CGI->new;
	 my $template = Template->new;

	 my $pager    = Film->pager(20, $query->param('page') || 1);
	 my $movies   = $pager->retrieve_all;
	 $template->process($input, {
	     movies => $movies,
	     pager  => $pager,
	 });

	 # View: (MVC's V)
	 Matched [% pager.total_entries %] items.

	 [% WHILE (movie = movies.next) %]
	 Title: [% movie.title | html %]
	 [% END %]

	 ### navigation like: [1] [2] [3]
	 [% FOREACH num = [pager.first_page .. pager.last_page] %]
	 [% IF num == pager.current_page %][[% num %]]
	 [% ELSE %]<a href="display?page=[% num %]">[[% num %]]</a>[% END %]
	 [% END %]

	 ### navigation like: prev 20 | next 20
	 [% IF pager.previous_page %]
	 <a href="display?page=[% pager.previous_page %]">
	 prev [% pager.entries_per_page %]</a> |
	 [% END %]
	 [% IF pager.next_page %]
	 <a href="display?page=[% pager.next_page %]">
	 next [% pager.entries_per_page %]</a>
	 [% END %]

NOTE 
/ TODO
       This modules internally retrieves itertors, then creates "Data::Page" object for paging utility. Using SQL clauses "LIMIT" and/or "OFFSET"
       with "DBIx::Pager" might be more memory efficient.

AUTHOR

       Tatsuhiko Miyagawa <miyagawa@bulknews.net>

       Original idea by Tomohiro Ikebe <ikebe@cpan.org>

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

SEE ALSO

       Class::DBI, Data::Page

perl v5.10.0							    2006-03-01						    Class::DBI::Pager(3pm)