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 Koha::Exceptions::Patron::Attribute::InvalidType->throw( type => $self->code )
52 Koha::Exceptions::Patron::Attribute::NonRepeatable->throw( attribute => $self )
53 unless $self->repeatable_ok();
55 Koha::Exceptions::Patron::Attribute::UniqueIDConstraint->throw( attribute => $self )
56 unless $self->unique_ok();
58 return $self->SUPER::store();
63 my $attribute_type = $attribute->type;
65 Returns a C<Koha::Patron::Attribute::Type> object corresponding to the current patron attribute
73 return scalar Koha::Patron::Attribute::Types->find( $self->code );
76 =head3 authorised_value
78 my $authorised_value = $attribute->authorised_value;
80 Return the Koha::AuthorisedValue object of this attribute when one is attached.
82 Return undef if this attribute is not attached to an authorised value
86 sub authorised_value {
89 return unless $self->type->authorised_value_category;
91 my $av = Koha::AuthorisedValues->search(
93 category => $self->type->authorised_value_category,
94 authorised_value => $self->attribute,
97 return unless $av->count; # Data inconsistency
103 my $description = $patron_attribute->description;
105 Return the value of this attribute or the description of the authorised value (when attached).
107 This method must be called when the authorised value's description must be
108 displayed instead of the code.
114 if ( $self->type->authorised_value_category ) {
115 my $av = $self->authorised_value;
116 return $av ? $av->lib : "";
118 return $self->attribute;
121 =head3 to_api_mapping
123 This method returns the mapping for representing a Koha::Patron::Attribute object
130 id => 'extended_attribute_id',
131 attribute => 'value',
132 borrowernumber => undef,
139 Checks if the attribute type is repeatable and returns a boolean representing
140 whether storing the current object state would break the repeatable constraint.
149 if ( ! $self->type->repeatable ) {
151 borrowernumber => $self->borrowernumber,
155 $params->{id} = { '!=' => $self->id }
156 if $self->in_storage;
158 $ok = 0 if Koha::Patron::Attributes->search($params)->count > 0;
166 Checks if the attribute type is marked as unique and returns a boolean representing
167 whether storing the current object state would break the unique constraint.
176 if ( $self->type->unique_id ) {
177 my $params = { code => $self->code, attribute => $self->attribute };
179 $params->{borrowernumber} = { '!=' => $self->borrowernumber } if $self->borrowernumber;
180 $params->{id} = { '!=' => $self->id } if $self->in_storage;
182 my $unique_count = Koha::Patron::Attributes
186 $ok = 0 if $unique_count > 0;
192 =head2 Internal methods
199 return 'BorrowerAttribute';