Fix for Bug 4290 - search for author in repository
[koha.git] / C4 / Members.pm
index 30e9f2d..00716cd 100644 (file)
@@ -56,6 +56,8 @@ BEGIN {
                &getzipnamecity 
                &getidcity
 
+                &GetFirstValidEmailAddress
+
                &GetAge 
                &GetCities 
                &GetRoadTypes 
@@ -133,13 +135,10 @@ This module contains routines for adding, modifying and deleting members/patrons
 
 =head1 FUNCTIONS
 
-=over 2
-
-=item SearchMember
+=head2 SearchMember
 
-  ($count, $borrowers) = &SearchMember($searchstring, $type,$category_type,$filter,$showallbranches);
-
-=back
+  ($count, $borrowers) = &SearchMember($searchstring, $type, 
+                     $category_type, $filter, $showallbranches);
 
 Looks up patrons (borrowers) by name.
 
@@ -245,13 +244,10 @@ sub SearchMember {
     return ( scalar(@$data), $data );
 }
 
-=over 2
+=head2 Search
 
-=item Search
-
-  $borrowers_result_array_ref = &Search($filter,$orderby, $limit, $columns_out, $search_on_fields,$searchtype);
-
-=back
+  $borrowers_result_array_ref = &Search($filter,$orderby, $limit, 
+                       $columns_out, $search_on_fields,$searchtype);
 
 Looks up patrons (borrowers) on filter.
 
@@ -378,9 +374,9 @@ sub GetMemberDetails {
 
  $flags = &patronflags($patron);
 
- This function is not exported.
+This function is not exported.
 
- The following will be set where applicable:
+The following will be set where applicable:
  $flags->{CHARGES}->{amount}        Amount of debt
  $flags->{CHARGES}->{noissues}      Set if debt amount >$5.00 (or syspref noissuescharge)
  $flags->{CHARGES}->{message}       Message -- deprecated
@@ -412,17 +408,17 @@ sub GetMemberDetails {
  $flags->{WAITING}->{message}       Message -- deprecated
  $flags->{WAITING}->{itemlist}      ref-to-array: list of available items
 
-=over 4
+=over 
 
-C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
+=item C<$flags-E<gt>{ODUES}-E<gt>{itemlist}> is a reference-to-array listing the
 overdue items. Its elements are references-to-hash, each describing an
 overdue item. The keys are selected fields from the issues, biblio,
 biblioitems, and items tables of the Koha database.
 
-C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
+=item C<$flags-E<gt>{ODUES}-E<gt>{itemlisttext}> is a string giving a text listing of
 the overdue items, one per line.  Deprecated.
 
-C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
+=item C<$flags-E<gt>{WAITING}-E<gt>{itemlist}> is a reference-to-array listing the
 available items. Each element is a reference-to-hash whose keys are
 fields from the reserves table of the Koha database.
 
@@ -488,7 +484,7 @@ sub patronflags {
         $flags{'NOTES'}      = \%flaginfo;
     }
     my ( $odues, $itemsoverdue ) = checkoverdues($patroninformation->{'borrowernumber'});
-    if ( $odues > 0 ) {
+    if ( $odues && $odues > 0 ) {
         my %flaginfo;
         $flaginfo{'message'}  = "Yes";
         $flaginfo{'itemlist'} = $itemsoverdue;
@@ -577,11 +573,7 @@ sub GetMember {
 
 =head2 IsMemberBlocked
 
-=over 4
-
-my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
-
-=back
+  my ($block_status, $count) = IsMemberBlocked( $borrowernumber );
 
 Returns whether a patron has overdue items that may result
 in a block or whether the patron has active fine days
@@ -698,22 +690,18 @@ sub columns(;$) {
     return @{C4::Context->dbh->selectcol_arrayref("SHOW columns from borrowers")};
 }
 
-=head2
-
 =head2 ModMember
 
-=over 4
-
-my $success = ModMember(borrowernumber => $borrowernumber, [ field => value ]... );
+  my $success = ModMember(borrowernumber => $borrowernumber,
+                                            [ field => value ]... );
 
 Modify borrower's data.  All date fields should ALREADY be in ISO format.
 
 return :
 true on success, or false on failure
 
-=back
-
 =cut
+
 sub ModMember {
     my (%data) = @_;
     # test to know if you must update or not the borrower password
@@ -740,8 +728,6 @@ sub ModMember {
 }
 
 
-=head2
-
 =head2 AddMember
 
   $borrowernumber = &AddMember(%borrower);
@@ -951,22 +937,16 @@ with the modified information
 
 #'
 sub UpdateGuarantees {
-    my (%data) = @_;
+    my %data = shift;
     my $dbh = C4::Context->dbh;
     my ( $count, $guarantees ) = GetGuarantees( $data{'borrowernumber'} );
-    for ( my $i = 0 ; $i < $count ; $i++ ) {
-
-        # FIXME
-        # It looks like the $i is only being returned to handle walking through
-        # the array, which is probably better done as a foreach loop.
-        #
+    foreach my $guarantee (@$guarantees){
         my $guaquery = qq|UPDATE borrowers 
-              SET address='$data{'address'}',fax='$data{'fax'}',
-                  B_city='$data{'B_city'}',mobile='$data{'mobile'}',city='$data{'city'}',phone='$data{'phone'}'
-              WHERE borrowernumber='$guarantees->[$i]->{'borrowernumber'}'
+              SET address=?,fax=?,B_city=?,mobile=?,city=?,phone=?
+              WHERE borrowernumber=?
         |;
-        my $sth3 = $dbh->prepare($guaquery);
-        $sth3->execute;
+        my $sth = $dbh->prepare($guaquery);
+        $sth->execute($data{'address'},$data{'fax'},$data{'B_city'},$data{'mobile'},$data{'city'},$data{'phone'},$guarantee->{'borrowernumber'});
     }
 }
 =head2 GetPendingIssues
@@ -1263,6 +1243,33 @@ sub getidcity {
     return $data;
 }
 
+=head2 GetFirstValidEmailAddress
+
+  $email = GetFirstValidEmailAddress($borrowernumber);
+
+Return the first valid email address for a borrower, given the borrowernumber.  For now, the order 
+is defined as email, emailpro, B_email.  Returns the empty string if the borrower has no email 
+addresses.
+
+=cut
+
+sub GetFirstValidEmailAddress {
+    my $borrowernumber = shift;
+    my $dbh = C4::Context->dbh;
+    my $sth = $dbh->prepare( "SELECT email, emailpro, B_email FROM borrowers where borrowernumber = ? ");
+    $sth->execute( $borrowernumber );
+    my $data = $sth->fetchrow_hashref;
+
+    if ($data->{'email'}) {
+       return $data->{'email'};
+    } elsif ($data->{'emailpro'}) {
+       return $data->{'emailpro'};
+    } elsif ($data->{'B_email'}) {
+       return $data->{'B_email'};
+    } else {
+       return '';
+    }
+}
 
 =head2 GetExpiryDate 
 
@@ -1357,8 +1364,9 @@ sub GetborCatFromCatType {
 
 Given the borrower's category code, the function returns the corresponding
 data hashref for a comprehensive information display.
-  
+
   $arrayref_hashref = &GetBorrowercategory;
+
 If no category code provided, the function returns all the categories.
 
 =cut
@@ -1382,7 +1390,7 @@ sub GetBorrowercategory {
 }    # sub getborrowercategory
 
 =head2 GetBorrowercategoryList
+
   $arrayref_hashref = &GetBorrowercategoryList;
 If no category code provided, the function returns all the categories.
 
@@ -1478,6 +1486,7 @@ sub GetAge{
 }    # sub get_age
 
 =head2 get_institutions
+
   $insitutions = get_institutions();
 
 Just returns a list of all the borrowers of type I, borrownumber and name
@@ -1603,7 +1612,7 @@ sub MoveMemberToDeleted {
 
 =head2 DelMember
 
-DelMember($borrowernumber);
+    DelMember($borrowernumber);
 
 This function remove directly a borrower whitout writing it on deleteborrower.
 + Deletes reserves for the borrower
@@ -1813,10 +1822,10 @@ WHERE roadtypeid=?|;
 
 =head2 GetBorrowersWhoHaveNotBorrowedSince
 
-&GetBorrowersWhoHaveNotBorrowedSince($date)
+  &GetBorrowersWhoHaveNotBorrowedSince($date)
 
 this function get all borrowers who haven't borrowed since the date given on input arg.
-      
+
 =cut
 
 sub GetBorrowersWhoHaveNotBorrowedSince {
@@ -1874,9 +1883,9 @@ sub GetBorrowersWhoHaveNotBorrowedSince {
 
 =head2 GetBorrowersWhoHaveNeverBorrowed
 
-$results = &GetBorrowersWhoHaveNeverBorrowed
+  $results = &GetBorrowersWhoHaveNeverBorrowed
 
-this function get all borrowers who have never borrowed.
+This function get all borrowers who have never borrowed.
 
 I<$result> is a ref to an array which all elements are a hasref.
 
@@ -1921,7 +1930,7 @@ sub GetBorrowersWhoHaveNeverBorrowed {
 
 =head2 GetBorrowersWithIssuesHistoryOlderThan
 
-$results = &GetBorrowersWithIssuesHistoryOlderThan($date)
+  $results = &GetBorrowersWithIssuesHistoryOlderThan($date)
 
 this function get all borrowers who has an issue history older than I<$date> given on input arg.
 
@@ -1966,7 +1975,7 @@ sub GetBorrowersWithIssuesHistoryOlderThan {
 
 =head2 GetBorrowersNamesAndLatestIssue
 
-$results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
+  $results = &GetBorrowersNamesAndLatestIssueList(@borrowernumbers)
 
 this function get borrowers Names and surnames and Issue information.
 
@@ -1992,9 +2001,7 @@ sub GetBorrowersNamesAndLatestIssue {
 
 =head2 DebarMember
 
-=over 4
-
-my $success = DebarMember( $borrowernumber );
+  my $success = DebarMember( $borrowernumber );
 
 marks a Member as debarred, and therefore unable to checkout any more
 items.
@@ -2002,8 +2009,6 @@ items.
 return :
 true on success, false on failure
 
-=back
-
 =cut
 
 sub DebarMember {
@@ -2019,9 +2024,7 @@ sub DebarMember {
 
 =head2 AddMessage
 
-=over 4
-
-AddMessage( $borrowernumber, $message_type, $message, $branchcode );
+  AddMessage( $borrowernumber, $message_type, $message, $branchcode );
 
 Adds a message to the messages table for the given borrower.
 
@@ -2029,8 +2032,6 @@ Returns:
   True on success
   False on failure
 
-=back
-
 =cut
 
 sub AddMessage {
@@ -2051,17 +2052,13 @@ sub AddMessage {
 
 =head2 GetMessages
 
-=over 4
-
-GetMessages( $borrowernumber, $type );
+  GetMessages( $borrowernumber, $type );
 
 $type is message type, B for borrower, or L for Librarian.
 Empty type returns all messages of any type.
 
 Returns all messages for the given borrowernumber
 
-=back
-
 =cut
 
 sub GetMessages {
@@ -2076,7 +2073,7 @@ sub GetMessages {
     my $query = "SELECT
                   branches.branchname,
                   messages.*,
-                  DATE_FORMAT( message_date, '%m/%d/%Y' ) AS message_date_formatted,
+                  message_date,
                   messages.branchcode LIKE '$branchcode' AS can_delete
                   FROM messages, branches
                   WHERE borrowernumber = ?
@@ -2088,6 +2085,8 @@ sub GetMessages {
     my @results;
 
     while ( my $data = $sth->fetchrow_hashref ) {
+        my $d = C4::Dates->new( $data->{message_date}, 'iso' );
+        $data->{message_date_formatted} = $d->output;
         push @results, $data;
     }
     return \@results;
@@ -2096,17 +2095,13 @@ sub GetMessages {
 
 =head2 GetMessages
 
-=over 4
-
-GetMessagesCount( $borrowernumber, $type );
+  GetMessagesCount( $borrowernumber, $type );
 
 $type is message type, B for borrower, or L for Librarian.
 Empty type returns all messages of any type.
 
 Returns the number of messages for the given borrowernumber
 
-=back
-
 =cut
 
 sub GetMessagesCount {
@@ -2133,11 +2128,7 @@ sub GetMessagesCount {
 
 =head2 DeleteMessage
 
-=over 4
-
-DeleteMessage( $message_id );
-
-=back
+  DeleteMessage( $message_id );
 
 =cut