Koha/RefundLostItemFeeRules.pm

   1 package Koha::RefundLostItemFeeRules;
   2
   3 # Copyright Theke Solutions 2016
   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 Koha::Database;
  23 use Koha::Exceptions;
  24
  25 use Koha::RefundLostItemFeeRule;
  26
  27 use base qw(Koha::Objects);
  28
  29 =head1 NAME
  30
  31 Koha::RefundLostItemFeeRules - Koha RefundLostItemFeeRules object set class
  32
  33 =head1 API
  34
  35 =head2 Class Methods
  36
  37 =cut
  38
  39 =head3 type
  40
  41 =cut
  42
  43 sub _type {
  44     return 'RefundLostItemFeeRule';
  45 }
  46
  47 =head3 object_class
  48
  49 =cut
  50
  51 sub object_class {
  52     return 'Koha::RefundLostItemFeeRule';
  53 }
  54
  55 =head3 should_refund
  56
  57 Koha::RefundLostItemFeeRules->should_refund()
  58
  59 Returns a boolean telling if the fee needs to be refund given the
  60 passed params, and the current rules/sysprefs configuration.
  61
  62 =cut
  63
  64 sub should_refund {
  65
  66     my $self = shift;
  67     my $params = shift;
  68
  69     return $self->_effective_branch_rule( $self->_choose_branch( $params ) );
  70 }
  71
  72
  73 =head3 _effective_branch_rule
  74
  75 Koha::RefundLostItemFeeRules->_effective_branch_rule
  76
  77 Given a branch, returns a boolean representing the resulting rule.
  78 It tries the branch-specific first. Then falls back to the defined default.
  79
  80 =cut
  81
  82 sub _effective_branch_rule {
  83
  84     my $self   = shift;
  85     my $branch = shift;
  86
  87     my $specific_rule = $self->find({ branchcode => $branch });
  88
  89     return ( defined $specific_rule )
  90                 ? $specific_rule->refund
  91                 : $self->_default_rule;
  92 }
  93
  94 =head3 _choose_branch
  95
  96 my $branch = Koha::RefundLostItemFeeRules->_choose_branch({
  97                 current_branch => 'current_branch_code',
  98                 item_home_branch => 'item_home_branch',
  99                 item_holding_branch => 'item_holding_branch'
 100 });
 101
 102 Helper function that determines the branch to be used to apply the rule.
 103
 104 =cut
 105
 106 sub _choose_branch {
 107
 108     my $self = shift;
 109     my $param = shift;
 110
 111     my $behaviour = C4::Context->preference( 'RefundLostOnReturnControl' ) // 'CheckinLibrary';
 112
 113     my $param_mapping = {
 114            CheckinLibrary => 'current_branch',
 115            ItemHomeBranch => 'item_home_branch',
 116         ItemHoldingBranch => 'item_holding_branch'
 117     };
 118
 119     my $branch = $param->{ $param_mapping->{ $behaviour } };
 120
 121     if ( !defined $branch ) {
 122         Koha::Exceptions::MissingParameter->throw(
 123             "$behaviour requires the " .
 124             $param_mapping->{ $behaviour } .
 125             " param"
 126         );
 127     }
 128
 129     return $branch;
 130 }
 131
 132 =head3 _default_rule (internal)
 133
 134 This function returns the default rule defined for refunding lost
 135 item fees on return. It defaults to 1 if no rule is defined.
 136
 137 =cut
 138
 139 sub _default_rule {
 140
 141     my $self = shift;
 142     my $default_rule = $self->find({ branchcode => '*' });
 143
 144     return (defined $default_rule)
 145                 ? $default_rule->refund
 146                 : 1;
 147 }
 148
 149 1;