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 base qw(Koha::Object);
  27
  28 =head1 NAME
  29
  30 Koha::AudioAlert - Koha Audio Alert object class
  31
  32 =head1 API
  33
  34 =head2 Class Methods
  35
  36 =head3 store
  37
  38 Override base store to set default precedence
  39 if there is not one set already.
  40
  41 =cut
  42
  43 sub store {
  44     my ($self) = @_;
  45
  46     $self->precedence( Koha::AudioAlerts->get_next_precedence() ) unless defined $self->precedence();
  47
  48     return $self->SUPER::store();
  49 }
  50
  51 =head3 move
  52
  53 $alert->move('up');
  54
  55 Changes the alert's precedence up, down, top, or bottom
  56
  57 =cut
  58
  59 sub move {
  60     my ( $self, $where ) = @_;
  61
  62     return Koha::AudioAlerts->move( { audio_alert => $self, where => $where } );
  63 }
  64
  65 =head3 type
  66
  67 =cut
  68
  69 sub _type {
  70     return 'AudioAlert';
  71 }
  72
  73 =head1 AUTHOR
  74
  75 Kyle M Hall <kyle@bywatersolutions.com>
  76
  77 =cut
  78
  79 1;