Koha/Patron/Attributes.pm

   1 package Koha::Patron::Attributes;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Koha::Patron::Attribute;
  21 use Koha::Patron::Attribute::Types;
  22
  23 use base qw(Koha::Objects);
  24
  25 =head1 NAME
  26
  27 Koha::Patron::Attributes - Koha Patron Attributes Object set class
  28
  29 =head1 API
  30
  31 =head2 Class Methods
  32
  33 =cut
  34
  35 =head3 search
  36
  37 my $attributes = Koha::Patron::Attributes->search( $params );
  38
  39 =cut
  40
  41 sub search {
  42     my ( $self, $params, $attributes ) = @_;
  43
  44     unless ( exists $attributes->{order_by} ) { $attributes->{order_by} = ['me.code', 'attribute'] }
  45
  46     return $self->SUPER::search( $params, $attributes );
  47 }
  48
  49 =head3 filter_by_branch_limitations
  50
  51 my $attributes = Koha::Patron::Attributes->filter_by_branch_limitations([$branchcode]);
  52
  53 Search patron attributes filtered by a library
  54
  55 If $branchcode exists it will be used to filter the result set.
  56
  57 Otherwise it will be the library of the logged in user.
  58
  59 =cut
  60
  61 sub filter_by_branch_limitations {
  62     my ( $self, $branchcode ) = @_;
  63
  64     # Maybe we should not limit if logged in user is superlibrarian?
  65     my $branch_limit =
  66         $branchcode          ? $branchcode
  67         # Do we raise an exception if no userenv defined?
  68       : C4::Context->userenv ? C4::Context->userenv->{"branch"}
  69       :                        undef;
  70
  71     my $or = $branch_limit
  72       ? {
  73         '-or' => [
  74             'borrower_attribute_types_branches.b_branchcode' => undef,
  75             'borrower_attribute_types_branches.b_branchcode' => $branch_limit,
  76         ]
  77       }
  78       : {};
  79
  80     my $join = $branch_limit
  81       ? {
  82         join => {
  83             code => 'borrower_attribute_types_branches'
  84         },
  85       }
  86       : {};
  87     return $self->search( $or, $join );
  88 }
  89
  90 sub merge_with {
  91     my ( $self, $new_attributes ) = @_;
  92
  93     my @merged = $self->as_list;
  94     while ( my ( $attr ) = $new_attributes->next ) {
  95         unless ( $attr->code ) {
  96             warn "Cannot merge element: no 'code' defined";
  97             next;
  98         }
  99
 100         # FIXME Do we need that here or let ->store do the job?
 101         unless ( $attr->type ) {
 102             warn "Cannot merge element: unrecognized code = '$attr->code'";
 103             next;
 104         }
 105         unless ( $attr->type->repeatable ) {
 106             # filter out any existing attributes of the same code
 107             @merged = grep {$attr->code ne $_->code} @merged;
 108         }
 109
 110         push @merged, $attr;
 111     }
 112
 113     # WARNING - we would like to return a set, but $new_attributes is not in storage yet
 114     # Maybe there is something obvious I (JD) am missing
 115     return [ sort { $a->{code} cmp $b->{code} || $a->{attribute} cmp $b->{attribute} } @merged ];
 116 }
 117
 118 =head3 _type
 119
 120 =cut
 121
 122 sub _type {
 123     return 'BorrowerAttribute';
 124 }
 125
 126 sub object_class {
 127     return 'Koha::Patron::Attribute';
 128 }
 129
 130 1;