Bug 7317: Add missing 'use Encode' statement
[koha.git] / Koha / Biblio.pm
blobf4e5e2f9e2b288d3f3e715400f03c00d6eefa691
1 package Koha::Biblio;
3 # Copyright ByWater Solutions 2014
5 # This file is part of Koha.
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.
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.
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.
20 use Modern::Perl;
22 use Carp;
24 use C4::Biblio qw();
26 use Koha::Database;
27 use Koha::DateUtils qw( dt_from_string );
29 use base qw(Koha::Object);
31 use Koha::Items;
32 use Koha::Biblioitems;
33 use Koha::ArticleRequests;
34 use Koha::ArticleRequest::Status;
35 use Koha::IssuingRules;
36 use Koha::Subscriptions;
38 =head1 NAME
40 Koha::Biblio - Koha Biblio Object class
42 =head1 API
44 =head2 Class Methods
46 =cut
48 =head3 subtitles
50 my @subtitles = $biblio->subtitles();
52 Returns list of subtitles for a record.
54 Keyword to MARC mapping for subtitle must be set for this method to return any possible values.
56 =cut
58 sub subtitles {
59 my ( $self ) = @_;
61 return map { $_->{subfield} } @{
62 C4::Biblio::GetRecordValue(
63 'subtitle',
64 C4::Biblio::GetMarcBiblio({ biblionumber => $self->id }),
65 $self->frameworkcode ) };
68 =head3 can_article_request
70 my $bool = $biblio->can_article_request( $borrower );
72 Returns true if article requests can be made for this record
74 $borrower must be a Koha::Patron object
76 =cut
78 sub can_article_request {
79 my ( $self, $borrower ) = @_;
81 my $rule = $self->article_request_type($borrower);
82 return q{} if $rule eq 'item_only' && !$self->items()->count();
83 return 1 if $rule && $rule ne 'no';
85 return q{};
88 =head3 article_request_type
90 my $type = $biblio->article_request_type( $borrower );
92 Returns the article request type based on items, or on the record
93 itself if there are no items.
95 $borrower must be a Koha::Patron object
97 =cut
99 sub article_request_type {
100 my ( $self, $borrower ) = @_;
102 return q{} unless $borrower;
104 my $rule = $self->article_request_type_for_items( $borrower );
105 return $rule if $rule;
107 # If the record has no items that are requestable, go by the record itemtype
108 $rule = $self->article_request_type_for_bib($borrower);
109 return $rule if $rule;
111 return q{};
114 =head3 article_request_type_for_bib
116 my $type = $biblio->article_request_type_for_bib
118 Returns the article request type 'yes', 'no', 'item_only', 'bib_only', for the given record
120 =cut
122 sub article_request_type_for_bib {
123 my ( $self, $borrower ) = @_;
125 return q{} unless $borrower;
127 my $borrowertype = $borrower->categorycode;
128 my $itemtype = $self->itemtype();
130 my $issuing_rule = Koha::IssuingRules->get_effective_issuing_rule({ categorycode => $borrowertype, itemtype => $itemtype });
132 return q{} unless $issuing_rule;
133 return $issuing_rule->article_requests || q{}
136 =head3 article_request_type_for_items
138 my $type = $biblio->article_request_type_for_items
140 Returns the article request type 'yes', 'no', 'item_only', 'bib_only', for the given record's items
142 If there is a conflict where some items are 'bib_only' and some are 'item_only', 'bib_only' will be returned.
144 =cut
146 sub article_request_type_for_items {
147 my ( $self, $borrower ) = @_;
149 my $counts;
150 foreach my $item ( $self->items()->as_list() ) {
151 my $rule = $item->article_request_type($borrower);
152 return $rule if $rule eq 'bib_only'; # we don't need to go any further
153 $counts->{$rule}++;
156 return 'item_only' if $counts->{item_only};
157 return 'yes' if $counts->{yes};
158 return 'no' if $counts->{no};
159 return q{};
162 =head3 article_requests
164 my @requests = $biblio->article_requests
166 Returns the article requests associated with this Biblio
168 =cut
170 sub article_requests {
171 my ( $self, $borrower ) = @_;
173 $self->{_article_requests} ||= Koha::ArticleRequests->search( { biblionumber => $self->biblionumber() } );
175 return wantarray ? $self->{_article_requests}->as_list : $self->{_article_requests};
178 =head3 article_requests_current
180 my @requests = $biblio->article_requests_current
182 Returns the article requests associated with this Biblio that are incomplete
184 =cut
186 sub article_requests_current {
187 my ( $self, $borrower ) = @_;
189 $self->{_article_requests_current} ||= Koha::ArticleRequests->search(
191 biblionumber => $self->biblionumber(),
192 -or => [
193 { status => Koha::ArticleRequest::Status::Pending },
194 { status => Koha::ArticleRequest::Status::Processing }
199 return wantarray ? $self->{_article_requests_current}->as_list : $self->{_article_requests_current};
202 =head3 article_requests_finished
204 my @requests = $biblio->article_requests_finished
206 Returns the article requests associated with this Biblio that are completed
208 =cut
210 sub article_requests_finished {
211 my ( $self, $borrower ) = @_;
213 $self->{_article_requests_finished} ||= Koha::ArticleRequests->search(
215 biblionumber => $self->biblionumber(),
216 -or => [
217 { status => Koha::ArticleRequest::Status::Completed },
218 { status => Koha::ArticleRequest::Status::Canceled }
223 return wantarray ? $self->{_article_requests_finished}->as_list : $self->{_article_requests_finished};
226 =head3 items
228 my @items = $biblio->items();
229 my $items = $biblio->items();
231 Returns the related Koha::Items object for this biblio in scalar context,
232 or list of Koha::Item objects in list context.
234 =cut
236 sub items {
237 my ($self) = @_;
239 $self->{_items} ||= Koha::Items->search( { biblionumber => $self->biblionumber() } );
241 return wantarray ? $self->{_items}->as_list : $self->{_items};
244 =head3 itemtype
246 my $itemtype = $biblio->itemtype();
248 Returns the itemtype for this record.
250 =cut
252 sub itemtype {
253 my ( $self ) = @_;
255 return $self->biblioitem()->itemtype();
258 =head3 holds
260 my $holds = $biblio->holds();
262 return the current holds placed on this record
264 =cut
266 sub holds {
267 my ( $self, $params, $attributes ) = @_;
268 $attributes->{order_by} = 'priority' unless exists $attributes->{order_by};
269 my $hold_rs = $self->_result->reserves->search( $params, $attributes );
270 return Koha::Holds->_new_from_dbic($hold_rs);
273 =head3 current_holds
275 my $holds = $biblio->current_holds
277 Return the holds placed on this bibliographic record.
278 It does not include future holds.
280 =cut
282 sub current_holds {
283 my ($self) = @_;
284 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
285 return $self->holds(
286 { reservedate => { '<=' => $dtf->format_date(dt_from_string) } } );
289 =head3 biblioitem
291 my $field = $self->biblioitem()->itemtype
293 Returns the related Koha::Biblioitem object for this Biblio object
295 =cut
297 sub biblioitem {
298 my ($self) = @_;
300 $self->{_biblioitem} ||= Koha::Biblioitems->find( { biblionumber => $self->biblionumber() } );
302 return $self->{_biblioitem};
305 =head3 subscriptions
307 my $subscriptions = $self->subscriptions
309 Returns the related Koha::Subscriptions object for this Biblio object
311 =cut
313 sub subscriptions {
314 my ($self) = @_;
316 $self->{_subscriptions} ||= Koha::Subscriptions->search( { biblionumber => $self->biblionumber } );
318 return $self->{_subscriptions};
322 =head3 type
324 =cut
326 sub _type {
327 return 'Biblio';
330 =head1 AUTHOR
332 Kyle M Hall <kyle@bywatersolutions.com>
334 =cut