Koha/Suggestion.pm

   1 package Koha::Suggestion;
   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
  23 use Koha::Database;
  24 use Koha::DateUtils qw( dt_from_string );
  25 use Koha::Patrons;
  26
  27 use base qw(Koha::Object);
  28
  29 =head1 NAME
  30
  31 Koha::Suggestion - Koha Suggestion object class
  32
  33 =head1 API
  34
  35 =head2 Class methods
  36
  37 =cut
  38
  39 =head3 store
  40
  41 Override the default store behavior so that new suggestions have
  42 a suggesteddate of today
  43
  44 =cut
  45
  46 sub store {
  47     my ($self) = @_;
  48
  49     unless ( $self->suggesteddate() ) {
  50         $self->suggesteddate( dt_from_string()->ymd );
  51     }
  52
  53     return $self->SUPER::store();
  54 }
  55
  56 =head3 suggester
  57
  58     my $patron = $suggestion->suggester
  59
  60 Returns the I<Koha::Patron> for the suggestion generator. I<undef> is
  61 returned if no suggester is linked.
  62
  63 =cut
  64
  65 sub suggester {
  66     my ($self) = @_;
  67
  68     my $suggester_rs = $self->_result->suggester;
  69     return unless $suggester_rs;
  70     return Koha::Patron->_new_from_dbic($suggester_rs);
  71 }
  72
  73 =head3 manager
  74
  75 my $manager = $suggestion->manager;
  76
  77 Returns the manager of the suggestion (Koha::Patron for managedby field)
  78
  79 =cut
  80
  81 sub manager {
  82     my ($self) = @_;
  83     my $manager_rs = $self->_result->managedby;
  84     return unless $manager_rs;
  85     return Koha::Patron->_new_from_dbic($manager_rs);
  86 }
  87
  88 =head3 rejecter
  89
  90 my $rejecter = $suggestion->rejecter;
  91
  92 Returns the rejecter of the suggestion (Koha::Patron for rejectebby field)
  93
  94 =cut
  95
  96 sub rejecter {
  97     my ($self) = @_;
  98     my $rejecter_rs = $self->_result->managedby;
  99     return unless $rejecter_rs;
 100     return Koha::Patron->_new_from_dbic($rejecter_rs);
 101 }
 102
 103 =head3 last_modifier
 104
 105 my $last_modifier = $suggestion->last_modifier;
 106
 107 Returns the librarian who last modified the suggestion (Koha::Patron for lastmodificationby field)
 108
 109 =cut
 110
 111 sub last_modifier {
 112     my ($self) = @_;
 113     my $last_modifier_rs = $self->_result->managedby;
 114     return unless $last_modifier_rs;
 115     return Koha::Patron->_new_from_dbic($last_modifier_rs);
 116 }
 117
 118 =head3 fund
 119
 120 my $fund = $suggestion->fund;
 121
 122 Return the fund associated to the suggestion
 123
 124 =cut
 125
 126 sub fund {
 127     my ($self) = @_;
 128     my $fund_rs = $self->_result->budgetid;
 129     return unless $fund_rs;
 130     return Koha::Acquisition::Fund->_new_from_dbic($fund_rs);
 131 }
 132
 133 =head3 type
 134
 135 =cut
 136
 137 sub _type {
 138     return 'Suggestion';
 139 }
 140
 141 =head3 to_api_mapping
 142
 143 This method returns the mapping for representing a Koha::Patron object
 144 on the API.
 145
 146 =cut
 147
 148 sub to_api_mapping {
 149     return {
 150         suggestionid         => 'suggestion_id',
 151         suggestedby          => 'suggested_by',
 152         suggesteddate        => 'suggestion_date',
 153         managedby            => 'managed_by',
 154         manageddate          => 'managed_date',
 155         acceptedby           => 'accepted_by',
 156         accepteddate         => 'accepted_date',
 157         rejectedby           => 'rejected_by',
 158         rejecteddate         => 'rejected_date',
 159         lastmodificationdate => 'last_status_change_date',
 160         lastmodificationby   => 'last_status_change_by',
 161         STATUS               => 'status',
 162         note                 => 'note',
 163         author               => 'author',
 164         title                => 'title',
 165         copyrightdate        => 'copyright_date',
 166         publishercode        => 'publisher_code',
 167         date                 => 'timestamp',
 168         volumedesc           => 'volume_desc',
 169         publicationyear      => 'publication_year',
 170         place                => 'publication_place',
 171         isbn                 => 'isbn',
 172         biblionumber         => 'biblio_id',
 173         reason               => 'reason',
 174         patronreason         => 'patron_reason',
 175         budgetid             => 'budget_id',
 176         branchcode           => 'library_id',
 177         collectiontitle      => 'collection_title',
 178         itemtype             => 'item_type',
 179         quantity             => 'quantity',
 180         currency             => 'currency',
 181         price                => 'item_price',
 182         total                => 'total_price',
 183         archived             => 'archived',
 184     };
 185 }
 186
 187 =head1 AUTHOR
 188
 189 Kyle M Hall <kyle@bywatersolutions.com>
 190
 191 =cut
 192
 193 1;