Bug 15358: Fix authorities merge
[koha.git] / C4 / Contract.pm
blob75e437dded85929a819144a97972f598390c5bfd
1 package C4::Contract;
3 # Copyright 2009-2010 BibLibre SARL
5 # This file is part of Koha.
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.
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.
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>.
20 use Modern::Perl;
21 use strict;
22 #use warnings; FIXME - Bug 2505
23 use C4::Context;
24 use Koha::Database;
26 use vars qw($VERSION @ISA @EXPORT);
28 BEGIN {
29 # set the version for version checking
30 $VERSION = 3.07.00.049;
31 require Exporter;
32 @ISA = qw(Exporter);
33 @EXPORT = qw(
34 &GetContracts
35 &GetContract
36 &AddContract
37 &ModContract
38 &DelContract
42 =head1 NAME
44 C4::Contract - Koha functions for dealing with bookseller contracts.
46 =head1 SYNOPSIS
48 use C4::Contract;
50 =head1 DESCRIPTION
52 The functions in this module deal with contracts. They allow to
53 add a new contract, to modify it or to get some informations around
54 a contract.
56 =cut
59 =head2 GetContracts
61 $contractlist = GetContracts({
62 booksellerid => $booksellerid,
63 activeonly => $activeonly
64 });
66 Looks up the contracts that belong to a bookseller
68 Returns a list of contracts
70 =over
72 =item C<$booksellerid> is the "id" field in the "aqbooksellers" table.
74 =item C<$activeonly> if exists get only contracts that are still active.
76 =back
78 =cut
80 sub GetContracts {
81 my ($filters) = @_;
82 if( $filters->{activeonly} ) {
83 $filters->{contractenddate} = {'>=' => \'now()'};
84 delete $filters->{activeonly};
87 my $rs = Koha::Database->new()->schema->resultset('Aqcontract');
88 $rs = $rs->search($filters);
89 $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
90 return [ $rs->all ];
93 =head2 GetContract
95 $contract = GetContract( { contractnumber => $contractnumber } );
97 Looks up the contract that has PRIMKEY (contractnumber) value $contractID
99 Returns a contract
101 =cut
103 sub GetContract {
104 my ($params) = @_;
105 my $contractnumber = $params->{contractnumber};
107 return unless $contractnumber;
109 my $contracts = GetContracts({
110 contractnumber => $contractnumber,
112 return $contracts->[0];
115 sub AddContract {
116 my ($contract) = @_;
117 return unless($contract->{booksellerid});
119 my $rs = Koha::Database->new()->schema->resultset('Aqcontract');
120 return $rs->create($contract)->id;
123 sub ModContract {
124 my ($contract) = @_;
125 my $result = Koha::Database->new()->schema->resultset('Aqcontract')->find($contract);
126 return unless($result);
128 $result = $result->update($contract);
129 return $result->in_storage;
132 sub DelContract {
133 my ($contract) = @_;
134 return unless($contract->{contractnumber});
136 my $result = Koha::Database->new()->schema->resultset('Aqcontract')->find($contract);
137 return unless($result);
139 eval { $result->delete };
140 return !( $result->in_storage );
145 __END__
147 =head1 AUTHOR
149 Koha Development Team <http://koha-community.org/>
151 =cut