koha-dev.rot13.org Git - srvgit/blob - Koha/NewsItem.pm

   1 package Koha::NewsItem;
   2
   3 # Copyright ByWater Solutions 2015
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use Carp;
  23
  24 use Koha::Database;
  25 use Koha::DateUtils;
  26 use Koha::Libraries;
  27 use Koha::Patrons;
  28
  29 use base qw(Koha::Object);
  30
  31 =head1 NAME
  32
  33 Koha::NewsItem - Koha News Item object class
  34
  35 Koha::NewsItem represents a single piece of news from the opac_news table
  36
  37 =head1 API
  38
  39 =head2 Class Methods
  40
  41 =cut
  42
  43 =head3 author
  44
  45     $newsitem->author;
  46
  47 Return the Koha::Patron object for the patron who authored this news item
  48
  49 =cut
  50
  51 sub author {
  52     my ($self) = @_;
  53     my $author_rs = $self->_result->borrowernumber;
  54     return unless $author_rs;
  55     return Koha::Patron->_new_from_dbic($author_rs);
  56 }
  57
  58 =head3 is_expired
  59
  60 my $is_expired = $news_item->is_expired;
  61
  62 Returns 1 if the news item is expired or 0;
  63
  64 =cut
  65
  66 sub is_expired {
  67     my ( $self ) = @_;
  68
  69     return 0 unless $self->expirationdate;
  70     return 1 if dt_from_string( $self->expirationdate ) < dt_from_string->truncate( to => 'day' );
  71     return 0;
  72 }
  73
  74 =head3 library
  75
  76 my $library = $news_item->library;
  77
  78 Returns Koha::Library object or undef
  79
  80 =cut
  81
  82 sub library {
  83     my ( $self ) = @_;
  84
  85     my $library_rs = $self->_result->branchcode;
  86     return unless $library_rs;
  87     return Koha::Library->_new_from_dbic( $library_rs );
  88 }
  89
  90
  91 =head3 _type
  92
  93 =cut
  94
  95 sub _type {
  96     return 'OpacNews';
  97 }
  98
  99 =head1 AUTHOR
 100
 101 Kyle M Hall <kyle@bywatersolutions.com>
 102
 103 =cut
 104
 105 1;