Koha-clms/Koha/AuthorisedValue.pm

145 lines
2.7 KiB
Perl

package Koha::AuthorisedValue;
# Copyright ByWater Solutions 2014
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY 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, see <http://www.gnu.org/licenses>.
use Modern::Perl;
use Koha::Caches;
use Koha::Database;
use base qw(Koha::Object Koha::Object::Limit::Library);
my $cache = Koha::Caches->get_instance();
=head1 NAME
Koha::AuthorisedValue - Koha Authorised value Object class
=head1 API
=head2 Class methods
=cut
=head3 store
AuthorisedValue specific store to ensure relevant caches are flushed on change
=cut
sub store {
my ($self) = @_;
my $flush = 0;
if ( !$self->in_storage ) {
$flush = 1;
}
else {
my %updated_columns = $self->_result->get_dirty_columns;
if ( exists $updated_columns{lib}
or exists $updated_columns{lib_opac} )
{
$flush = 1;
}
}
$self = $self->SUPER::store;
if ($flush) {
my $key = "AV_descriptions:".$self->category;
$cache->clear_from_cache($key);
}
return $self;
}
=head2 delete
AuthorisedValue specific C<delete> to clear relevant caches on delete.
=cut
sub delete {
my $self = shift @_;
my $key = "AV_descriptions:".$self->category;
$cache->clear_from_cache($key);
$self->SUPER::delete(@_);
}
=head3 opac_description
my $description = $av->opac_description();
=cut
sub opac_description {
my ( $self, $value ) = @_;
return $self->lib_opac() || $self->lib();
}
=head3 to_api_mapping
This method returns the mapping for representing a Koha::AuthorisedValue object
on the API.
=cut
sub to_api_mapping {
return {
id => 'authorised_value_id',
category => 'category_name',
authorised_value => 'value',
lib => 'description',
lib_opac => 'opac_description',
imageurl => 'image_url',
};
}
=head2 Internal methods
=head3 _type
=cut
sub _type {
return 'AuthorisedValue';
}
=head3 _library_limits
=cut
sub _library_limits {
return {
class => 'AuthorisedValuesBranch',
id => 'av_id',
library => 'branchcode'
};
}
=head1 AUTHOR
Kyle M Hall <kyle@bywatersolutions.com>
=cut
1;