1 package C4
::ClassSortRoutine
;
3 # Copyright (C) 2007 LibLime
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
24 use Class
::Factory
::Util
;
27 use vars
qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
29 # set the version for version checking
30 $VERSION = 3.07.00.049;
34 C4::ClassSortRoutine - base object for creation of classification sorting
35 key generation routines
39 use C4::ClassSortRoutine;
52 my %loaded_routines = ();
53 my @sort_routines = GetSortRoutineNames
();
54 foreach my $sort_routine (@sort_routines) {
55 if (eval "require C4::ClassSortRoutine::$sort_routine") {
57 eval "\$ref = \\\&C4::ClassSortRoutine::${sort_routine}::get_class_sort_key";
58 if (eval "\$ref->(\"a\", \"b\")") {
59 $loaded_routines{$sort_routine} = $ref;
61 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
64 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
68 =head2 GetSortRoutineNames
70 my @routines = GetSortRoutineNames();
72 Get names of all modules under C4::ClassSortRoutine::*. Adding
73 a new classification sorting routine can therefore be done
74 simply by writing a new submodule under C4::ClassSortRoutine and
75 placing it in the C4/ClassSortRoutine directory.
79 sub GetSortRoutineNames
{
80 return C4
::ClassSortRoutine
->subclasses();
83 =head2 GetClassSortKey
85 my $cn_sort = GetClassSortKey($sort_routine, $cn_class, $cn_item);
87 Generates classification sorting key. If $sort_routine does not point
88 to a valid submodule in C4::ClassSortRoutine, default to a basic
89 normalization routine.
94 my ($sort_routine, $cn_class, $cn_item) = @_;
95 unless (exists $loaded_routines{$sort_routine}) {
96 warn "attempting to use non-existent class sorting routine $sort_routine\n";
97 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
99 my $key = $loaded_routines{$sort_routine}->($cn_class, $cn_item);
100 # FIXME -- hardcoded length for cn_sort
101 # should replace with some way of getting column widths from
102 # the DB schema -- since doing this should ideally be
103 # independent of the DBMS, deferring for the moment.
104 return substr($key, 0, 255);
107 =head2 _get_class_sort_key
109 Basic sorting function. Concatenates classification part
110 and item, converts to uppercase, changes each run of
111 whitespace to '_', and removes any non-digit, non-latin
116 sub _get_class_sort_key
{
117 my ($cn_class, $cn_item) = @_;
118 my $key = uc "$cn_class $cn_item";
120 $key =~ s/[^A-Z_0-9]//g;
128 Koha Development Team <http://koha-community.org/>