/usr/share/perl5/Class/DBI/Plugin/RetrieveAll.pm is in libclass-dbi-plugin-retrieveall-perl 1.04-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | package Class::DBI::Plugin::RetrieveAll;
our $VERSION = '1.04';
use strict;
use warnings;
=head1 NAME
Class::DBI::Plugin::RetrieveAll - more complex retrieve_all() for Class::DBI
=head1 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;
=head1 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.
=head1 METHODS
=head2 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");
=head2 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.
=cut
sub import {
my $caller = caller();
no strict 'refs';
$caller->set_sql(retrieve_all_sorted => <<'');
SELECT __ESSENTIAL__
FROM __TABLE__
ORDER BY %s
*{"$caller\::retrieve_all_sorted_by"} = sub {
my ($class, $order_by) = @_;
return $class->sth_to_objects($class->sql_retrieve_all_sorted($order_by));
};
$caller->mk_classdata('__plugin_retall_sortfield');
*{"$caller\::retrieve_all_sort_field"} = sub {
my ($class, $field) = @_;
$class->__plugin_retall_sortfield($field);
};
# I hate that SUPER means *my* SUPER *now* - not $class->SUPER then
my $super = $caller->can('retrieve_all');
*{"$caller\::retrieve_all"} = sub {
my $class = shift;
my $field = $class->__plugin_retall_sortfield
or return $super->($class);
return $class->retrieve_all_sorted_by($field);
};
}
=head1 AUTHOR
Tony Bowden
=head1 BUGS and QUERIES
Please direct all correspondence regarding this module to:
bug-Class-DBI-Plugin-RetrieveAll@rt.cpan.org
=head1 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.
=cut
1;
|