1 package Koha::Patron::Attribute;
3 # This file is part of Koha.
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.
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.
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>.
21 use Koha::Exceptions::Patron::Attribute;
22 use Koha::Patron::Attribute::Types;
23 use Koha::AuthorisedValues;
25 use base qw(Koha::Object);
29 Koha::Patron::Attribute - Koha Patron Attribute Object class
39 my $attribute = Koha::Patron::Attribute->new({ code => 'a_code', ... });
40 try { $attribute->store }
41 catch { handle_exception };
49 $self->_check_repeatable;
50 $self->check_unique_id;
52 return $self->SUPER::store();
57 my $attribute_type = $attribute->type;
59 Returns a C<Koha::Patron::Attribute::Type> object corresponding to the current patron attribute
67 return scalar Koha::Patron::Attribute::Types->find( $self->code );
70 =head3 authorised_value
72 my $authorised_value = $attribute->authorised_value;
74 Return the Koha::AuthorisedValue object of this attribute when one is attached.
76 Return undef if this attribute is not attached to an authorised value
80 sub authorised_value {
83 return unless $self->type->authorised_value_category;
85 my $av = Koha::AuthorisedValues->search(
87 category => $self->type->authorised_value_category,
88 authorised_value => $self->attribute,
91 return unless $av->count; # Data inconsistency
97 my $description = $patron_attribute->description;
99 Return the value of this attribute or the description of the authorised value (when attached).
101 This method must be called when the authorised value's description must be
102 displayed instead of the code.
108 if ( $self->type->authorised_value_category ) {
109 return $self->authorised_value->lib;
111 return $self->attribute;
115 =head2 Internal methods
117 =head3 _check_repeatable
119 _check_repeatable checks if the attribute type is repeatable and throws and exception
120 if the attribute type isn't repeatable and there's already an attribute with the same
121 code for the given patron.
125 sub _check_repeatable {
129 if ( !$self->type->repeatable ) {
130 my $attr_count = Koha::Patron::Attributes->search(
131 { borrowernumber => $self->borrowernumber,
135 Koha::Exceptions::Patron::Attribute::NonRepeatable->throw()
142 =head3 check_unique_id
144 check_unique_id checks if the attribute type is marked as unique id and throws and exception
145 if the attribute type is a unique id and there's already an attribute with the same
146 code and value on the database.
150 sub check_unique_id {
154 if ( $self->type->unique_id ) {
155 my $params = { code => $self->code, attribute => $self->attribute };
157 $params->{borrowernumber} = { '!=' => $self->borrowernumber } if $self->borrowernumber;
158 $params->{id} = { '!=' => $self->id } if $self->in_storage;
160 my $unique_count = Koha::Patron::Attributes
163 Koha::Exceptions::Patron::Attribute::UniqueIDConstraint->throw()
164 if $unique_count > 0;
175 return 'BorrowerAttribute';