svc/members/search

   1 #!/usr/bin/perl
   2
   3 # Copyright 2013 BibLibre
   4 #
   5 # This file is part of Koha
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21 use CGI;
  22
  23 use C4::Auth qw( get_template_and_user );
  24 use C4::Output qw( output_with_http_headers );
  25 use C4::Utils::DataTables qw( dt_get_params );
  26 use C4::Utils::DataTables::Members qw( search );
  27 use Koha::DateUtils qw( output_pref dt_from_string );
  28
  29 my $input = new CGI;
  30
  31 exit unless $input->param('template_path');
  32
  33 my ($template, $user, $cookie) = get_template_and_user({
  34     template_name   => $input->param('template_path'),
  35     query           => $input,
  36     type            => "intranet",
  37     authnotrequired => 0,
  38     flagsrequired   => { borrowers => 1 }
  39 });
  40
  41 my $searchmember = $input->param('searchmember');
  42 my $firstletter  = $input->param('firstletter');
  43 my $categorycode = $input->param('categorycode');
  44 my $branchcode = $input->param('branchcode');
  45 my $searchtype = $input->param('searchtype');
  46 my $searchfieldstype = $input->param('searchfieldstype');
  47
  48 if ( $searchfieldstype eq "dateofbirth" ) {
  49     $searchmember = output_pref({dt => dt_from_string($searchmember), dateformat => 'iso', dateonly => 1});
  50 }
  51
  52 # variable information for DataTables (id)
  53 my $sEcho = $input->param('sEcho');
  54
  55 my %dt_params = dt_get_params($input);
  56 foreach (grep {$_ =~ /^mDataProp/} keys %dt_params) {
  57     $dt_params{$_} =~ s/^dt_//;
  58 }
  59
  60 # Perform the patrons search
  61 my $results = C4::Utils::DataTables::Members::search(
  62     {
  63         searchmember => $searchmember,
  64         firstletter => $firstletter,
  65         categorycode => $categorycode,
  66         branchcode => $branchcode,
  67         searchtype => $searchtype,
  68         searchfieldstype => $searchfieldstype,
  69         dt_params => \%dt_params,
  70
  71     }
  72 );
  73
  74 $template->param(
  75     sEcho => $sEcho,
  76     iTotalRecords => $results->{iTotalRecords},
  77     iTotalDisplayRecords => $results->{iTotalDisplayRecords},
  78     aaData => $results->{patrons}
  79 );
  80
  81 output_with_http_headers $input, $cookie, $template->output, 'json';
  82
  83 __END__
  84
  85 =head1 NAME
  86
  87 search - a search script for finding patrons
  88
  89 =head1 SYNOPSIS
  90
  91 This script provides a service for template for patron search using DataTables
  92
  93 =head2 Performing a search
  94
  95 Call this script from a DataTables table my $searchmember = $input->param('searchmember');
  96 All following params are optional:
  97     searchmember => the search terms
  98     firstletter => search patrons with surname begins with this pattern (currently only used for 1 letter)
  99     categorycode and branchcode => search patrons belong to a given categorycode or a branchcode
 100     searchtype: can be 'contain' or 'start_with'
 101     searchfieldstype: Can be 'standard', 'email', 'borrowernumber', 'phone' or 'address'
 102
 103 =cut
 104
 105 =back
 106
 107 =head1 LICENSE
 108
 109 Copyright 2013 BibLibre
 110
 111 This file is part of Koha.
 112
 113 Koha is free software; you can redistribute it and/or modify it under the
 114 terms of the GNU General Public License as published by the Free Software
 115 Foundation; either version 2 of the License, or (at your option) any later
 116 version.
 117
 118 Koha is distributed in the hope that it will be useful, but WITHOUT ANY
 119 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 120 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 121
 122 You should have received a copy of the GNU General Public License along
 123 with Koha; if not, write to the Free Software Foundation, Inc.,
 124 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.