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
33 C4::ClassSortRoutine - base object for creation of classification sorting
34 key generation routines
38 use C4::ClassSortRoutine;
51 my %loaded_routines = ();
52 my @sort_routines = GetSortRoutineNames
();
53 foreach my $sort_routine (@sort_routines) {
54 if (eval "require C4::ClassSortRoutine::$sort_routine") {
56 eval "\$ref = \\\&C4::ClassSortRoutine::${sort_routine}::get_class_sort_key";
57 if (eval "\$ref->(\"a\", \"b\")") {
58 $loaded_routines{$sort_routine} = $ref;
60 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
63 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
67 =head2 GetSortRoutineNames
69 my @routines = GetSortRoutineNames();
71 Get names of all modules under C4::ClassSortRoutine::*. Adding
72 a new classification sorting routine can therefore be done
73 simply by writing a new submodule under C4::ClassSortRoutine and
74 placing it in the C4/ClassSortRoutine directory.
78 sub GetSortRoutineNames
{
79 return C4
::ClassSortRoutine
->subclasses();
82 =head2 GetClassSortKey
84 my $cn_sort = GetClassSortKey($sort_routine, $cn_class, $cn_item);
86 Generates classification sorting key. If $sort_routine does not point
87 to a valid submodule in C4::ClassSortRoutine, default to a basic
88 normalization routine.
93 my ($sort_routine, $cn_class, $cn_item) = @_;
94 unless (exists $loaded_routines{$sort_routine}) {
95 warn "attempting to use non-existent class sorting routine $sort_routine\n";
96 $loaded_routines{$sort_routine} = \
&_get_class_sort_key
;
98 my $key = $loaded_routines{$sort_routine}->($cn_class, $cn_item);
99 # FIXME -- hardcoded length for cn_sort
100 # should replace with some way of getting column widths from
101 # the DB schema -- since doing this should ideally be
102 # independent of the DBMS, deferring for the moment.
103 return substr($key, 0, 255);
106 =head2 _get_class_sort_key
108 Basic sorting function. Concatenates classification part
109 and item, converts to uppercase, changes each run of
110 whitespace to '_', and removes any non-digit, non-latin
115 sub _get_class_sort_key
{
116 my ($cn_class, $cn_item) = @_;
117 my $key = uc "$cn_class $cn_item";
119 $key =~ s/[^A-Z_0-9]//g;
127 Koha Development Team <http://koha-community.org/>