Koha/Patron/Messages.pm

   1 package Koha::Patron::Messages;
   2
   3 # This file is part of Koha.
   4 #
   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.
   9 #
  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.
  14 #
  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>.
  17
  18 use Modern::Perl;
  19
  20
  21 use Koha::Database;
  22
  23 use Koha::Patron::Message;
  24
  25 use base qw(Koha::Objects);
  26
  27 =head1 NAME
  28
  29 Koha::Patron::Messages - Koha Message Object set class
  30
  31 =head1 API
  32
  33 =head2 Class Methods
  34
  35 =cut
  36
  37 =head3 filter_by_unread
  38
  39     Returns a resultset of messages that have not been marked read by the patron
  40
  41 =cut
  42
  43 sub filter_by_unread {
  44     my ( $self ) = @_;
  45
  46     return $self->search(
  47         {
  48             patron_read_date => { is => undef },
  49         }
  50     );
  51 }
  52
  53 =head3 _type
  54
  55 =cut
  56
  57 sub _type {
  58     return 'Message';
  59 }
  60
  61 =head3 object_class
  62
  63 =cut
  64
  65 sub object_class {
  66     return 'Koha::Patron::Message';
  67 }
  68
  69 1;