Bug 6836: Adding dependency on Modern::Perl
[koha_gimpoz] / C4 / Members / Attributes.pm
index 88c6c09..4ae5600 100644 (file)
@@ -13,9 +13,9 @@ package C4::Members::Attributes;
 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 use strict;
 use warnings;
@@ -31,8 +31,9 @@ BEGIN {
     # set the version for version checking
     $VERSION = 3.01;
     @ISA = qw(Exporter);
-    @EXPORT_OK = qw(GetBorrowerAttributes CheckUniqueness SetBorrowerAttributes
-                    extended_attributes_code_value_arrayref extended_attributes_merge);
+    @EXPORT_OK = qw(GetBorrowerAttributes GetBorrowerAttributeValue CheckUniqueness SetBorrowerAttributes
+                    extended_attributes_code_value_arrayref extended_attributes_merge
+                                       SearchIdMatchingAttribute);
     %EXPORT_TAGS = ( all => \@EXPORT_OK );
 }
 
@@ -42,22 +43,14 @@ C4::Members::Attributes - manage extend patron attributes
 
 =head1 SYNOPSIS
 
-=over 4
-
-    use C4::Members::Attributes;
-    my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber);
-
-=back
+  use C4::Members::Attributes;
+  my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber);
 
 =head1 FUNCTIONS
 
 =head2 GetBorrowerAttributes
 
-=over 4
-
-my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber[, $opac_only]);
-
-=back
+  my $attributes = C4::Members::Attributes::GetBorrowerAttributes($borrowernumber[, $opac_only]);
 
 Retrieve an arrayref of extended attributes associated with the
 patron specified by C<$borrowernumber>.  Each entry in the arrayref
@@ -79,7 +72,7 @@ sub GetBorrowerAttributes {
     my $opac_only = @_ ? shift : 0;
 
     my $dbh = C4::Context->dbh();
-    my $query = "SELECT code, description, attribute, lib, password
+    my $query = "SELECT code, description, attribute, lib, password, display_checkout
                  FROM borrower_attributes
                  JOIN borrower_attribute_types USING (code)
                  LEFT JOIN authorised_values ON (category = authorised_value_category AND attribute = authorised_value)
@@ -96,18 +89,59 @@ sub GetBorrowerAttributes {
             value             => $row->{'attribute'},  
             value_description => $row->{'lib'},  
             password          => $row->{'password'},
+            display_checkout  => $row->{'display_checkout'},
         }
     }
     return \@results;
 }
 
-=head2 CheckUniqueness
+=head2 GetBorrowerAttributeValue
+
+  my $value = C4::Members::Attributes::GetBorrowerAttributeValue($borrowernumber, $attribute_code);
+
+Retrieve the value of an extended attribute C<$attribute_code> associated with the
+patron specified by C<$borrowernumber>.
+
+=cut
+
+sub GetBorrowerAttributeValue {
+    my $borrowernumber = shift;
+    my $code = shift;
+
+    my $dbh = C4::Context->dbh();
+    my $query = "SELECT attribute
+                 FROM borrower_attributes
+                 WHERE borrowernumber = ?
+                 AND code = ?";
+    my $value = $dbh->selectrow_array($query, undef, $borrowernumber, $code);
+    return $value;
+}
+
+=head2 SearchIdMatchingAttribute
+
+  my $matching_borrowernumbers = C4::Members::Attributes::SearchIdMatchingAttribute($filter);
+
+=cut
 
-=over 4
+sub SearchIdMatchingAttribute{
+    my $filter = shift;
+    $filter = [$filter] unless ref $filter;
+
+    my $dbh   = C4::Context->dbh();
+    my $query = qq{
+SELECT DISTINCT borrowernumber
+FROM borrower_attributes
+JOIN borrower_attribute_types USING (code)
+WHERE staff_searchable = 1
+AND (} . join (" OR ", map "attribute like ?", @$filter) .qq{)};
+    my $sth = $dbh->prepare_cached($query);
+    $sth->execute(map "%$_%", @$filter);
+    return [map $_->[0], @{ $sth->fetchall_arrayref }];
+}
 
-    my $ok = CheckUniqueness($code, $value[, $borrowernumber]);
+=head2 CheckUniqueness
 
-=back
+  my $ok = CheckUniqueness($code, $value[, $borrowernumber]);
 
 Given an attribute type and value, verify if would violate
 a unique_id restriction if added to the patron.  The
@@ -151,11 +185,7 @@ sub CheckUniqueness {
 
 =head2 SetBorrowerAttributes 
 
-=over 4
-
-    SetBorrowerAttributes($borrowernumber, [ { code => 'CODE', value => 'value', password => 'password' }, ... ] );
-
-=back
+  SetBorrowerAttributes($borrowernumber, [ { code => 'CODE', value => 'value', password => 'password' }, ... ] );
 
 Set patron attributes for the patron identified by C<$borrowernumber>,
 replacing any that existed previously.
@@ -175,17 +205,18 @@ sub SetBorrowerAttributes {
     foreach my $attr (@$attr_list) {
         $attr->{password} = undef unless exists $attr->{password};
         $sth->execute($borrowernumber, $attr->{code}, $attr->{value}, $attr->{password});
+        if ($sth->err) {
+            warn sprintf('Database returned the following error: %s', $sth->errstr);
+            return; # bail immediately on errors
+        }
     }
+    return 1; # borower attributes successfully set
 }
 
 =head2 extended_attributes_code_value_arrayref 
 
-=over 4
-
-    my $patron_attributes = "homeroom:1150605,grade:01,extradata:foobar";
-    my $aref = extended_attributes_code_value_arrayref($patron_attributes);
-
-=back
+   my $patron_attributes = "homeroom:1150605,grade:01,extradata:foobar";
+   my $aref = extended_attributes_code_value_arrayref($patron_attributes);
 
 Takes a comma-delimited CSV-style string argument and returns the kind of data structure that SetBorrowerAttributes wants, 
 namely a reference to array of hashrefs like:
@@ -211,16 +242,12 @@ sub extended_attributes_code_value_arrayref {
 
 =head2 extended_attributes_merge
 
-=over 4
-
-    my $old_attributes = extended_attributes_code_value_arrayref("homeroom:224,grade:04,deanslist:2007,deanslist:2008,somedata:xxx");
-    my $new_attributes = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2009,extradata:foobar");
-    my $merged = extended_attributes_merge($patron_attributes, $new_attributes, 1);
-
-    # assuming deanslist is a repeatable code, value same as:
-    # $merged = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2007,deanslist:2008,deanslist:2009,extradata:foobar,somedata:xxx");
+  my $old_attributes = extended_attributes_code_value_arrayref("homeroom:224,grade:04,deanslist:2007,deanslist:2008,somedata:xxx");
+  my $new_attributes = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2009,extradata:foobar");
+  my $merged = extended_attributes_merge($patron_attributes, $new_attributes, 1);
 
-=back
+  # assuming deanslist is a repeatable code, value same as:
+  # $merged = extended_attributes_code_value_arrayref("homeroom:115,grade:05,deanslist:2007,deanslist:2008,deanslist:2009,extradata:foobar,somedata:xxx");
 
 Takes three arguments.  The first two are references to array of hashrefs, each like:
  [ { code => 'CODE', value => 'value' }, { code => 'CODE2', value => 'othervalue' } ... ]
@@ -265,7 +292,7 @@ sub _sort_by_code {
 
 =head1 AUTHOR
 
-Koha Development Team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
 
 Galen Charlton <galen.charlton@liblime.com>