C4/ClassSortRoutine/Generic.pm

   1 package C4::ClassSortRoutine::Generic;
   2
   3 # Copyright (C) 2007 LibLime
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use strict;
  21 use warnings;
  22
  23 use vars qw();
  24
  25
  26 =head1 NAME
  27
  28 C4::ClassSortRoutine::Generic - generic call number sorting key routine
  29
  30 =head1 SYNOPSIS
  31
  32 use C4::ClassSortRoutine;
  33
  34 my $cn_sort = GetClassSortKey('Generic', $cn_class, $cn_item);
  35
  36 =head1 FUNCTIONS
  37
  38 =head2 get_class_sort_key
  39
  40   my $cn_sort = C4::ClassSortRoutine::Generic::Generic($cn_class, $cn_item);
  41
  42 Generates sorting key using the following rules:
  43
  44 * Concatenates class and item part.
  45 * Removes leading and trailing whitespace.
  46 * Converts each run of whitespace to an underscore.
  47 * Converts to upper-case and removes non-alphabetical, non-numeric, non-underscore characters.
  48
  49 =cut
  50
  51 sub get_class_sort_key {
  52     my ($cn_class, $cn_item) = @_;
  53
  54     $cn_class = '' unless defined $cn_class;
  55     $cn_item  = '' unless defined $cn_item;
  56     my $key = uc "$cn_class $cn_item";
  57     $key =~ s/^\s+//;
  58     $key =~ s/\s+$//;
  59     $key =~ s/\s+/_/g;
  60     $key =~ s/[^\p{IsAlnum}_]//g;
  61     return $key;
  62
  63 }
  64
  65 1;
  66
  67 =head1 AUTHOR
  68
  69 Koha Development Team <http://koha-community.org/>
  70
  71 =cut
  72