Koha/AudioAlert.pm

   1 package Koha::AudioAlert;
   2
   3 # Copyright ByWater Solutions 2014
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 3 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along
  17 # with Koha; if not, write to the Free Software Foundation, Inc.,
  18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25
  26 use Koha::Patron::Modifications;
  27 use Koha::Exceptions::Patron::Modification;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::AudioAlert - Koha Audio Alert object class
  34
  35 =head1 API
  36
  37 =head2 store
  38
  39 =cut
  40
  41 sub store {
  42     my ($self) = @_;
  43
  44     if ( $self->verification_token ) {
  45         if ( Koha::Patron::Modifications->search( { verification_token => $self->verification_token } )->count() ) {
  46             Koha::Exceptions::Patron::Modification::DuplicateVerificationToken->throw(
  47                 "Duplicate verification token " . $self->verification_token
  48             );
  49         }
  50     }
  51
  52     return $self->SUPER::store();
  53 }
  54
  55 =head2 approve
  56
  57 =head3 store
  58
  59 Override base store to set default precedence
  60 if there is not one set already.
  61
  62 =cut
  63
  64 sub store {
  65     my ($self) = @_;
  66
  67     $self->precedence( Koha::AudioAlerts->get_next_precedence() ) unless defined $self->precedence();
  68
  69     return $self->SUPER::store();
  70 }
  71
  72 =head3 move
  73
  74 $alert->move('up');
  75
  76 Changes the alert's precedence up, down, top, or bottom
  77
  78 =cut
  79
  80 sub move {
  81     my ( $self, $where ) = @_;
  82
  83     return Koha::AudioAlerts->move( { audio_alert => $self, where => $where } );
  84 }
  85
  86 =head3 type
  87
  88 =cut
  89
  90 sub _type {
  91     return 'AudioAlert';
  92 }
  93
  94 =head1 AUTHOR
  95
  96 Kyle M Hall <kyle@bywatersolutions.com>
  97
  98 =cut
  99
 100 1;